diff --git a/.changes/next-release/api-change-clients-50666.json b/.changes/next-release/api-change-clients-50666.json new file mode 100644 index 000000000000..ab12bc805d83 --- /dev/null +++ b/.changes/next-release/api-change-clients-50666.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "clients", + "description": "The following clients have been removed per deprecation of the services - qldb, robomaker, waf, lookoutmetrics, lookoutvision, iotfleethub, apptest" +} diff --git a/awscli/botocore/data/apptest/2022-12-06/endpoint-rule-set-1.json b/awscli/botocore/data/apptest/2022-12-06/endpoint-rule-set-1.json deleted file mode 100644 index f09500ef3825..000000000000 --- a/awscli/botocore/data/apptest/2022-12-06/endpoint-rule-set-1.json +++ /dev/null @@ -1,350 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/apptest/2022-12-06/paginators-1.json b/awscli/botocore/data/apptest/2022-12-06/paginators-1.json deleted file mode 100644 index 56c715f68df7..000000000000 --- a/awscli/botocore/data/apptest/2022-12-06/paginators-1.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "pagination": { - "ListTestCases": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "testCases" - }, - "ListTestConfigurations": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "testConfigurations" - }, - "ListTestRunSteps": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "testRunSteps" - }, - "ListTestRunTestCases": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "testRunTestCases" - }, - "ListTestRuns": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "testRuns" - }, - "ListTestSuites": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "testSuites" - } - } -} diff --git a/awscli/botocore/data/apptest/2022-12-06/service-2.json b/awscli/botocore/data/apptest/2022-12-06/service-2.json deleted file mode 100644 index fe14ff269e65..000000000000 --- a/awscli/botocore/data/apptest/2022-12-06/service-2.json +++ /dev/null @@ -1,3510 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2022-12-06", - "auth":["aws.auth#sigv4"], - "endpointPrefix":"apptest", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"AWS Mainframe Modernization Application Testing", - "serviceId":"AppTest", - "signatureVersion":"v4", - "signingName":"apptest", - "uid":"apptest-2022-12-06" - }, - "operations":{ - "CreateTestCase":{ - "name":"CreateTestCase", - "http":{ - "method":"POST", - "requestUri":"/testcase", - "responseCode":201 - }, - "input":{"shape":"CreateTestCaseRequest"}, - "output":{"shape":"CreateTestCaseResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"
Creates a test case.
", - "idempotent":true - }, - "CreateTestConfiguration":{ - "name":"CreateTestConfiguration", - "http":{ - "method":"POST", - "requestUri":"/testconfiguration", - "responseCode":201 - }, - "input":{"shape":"CreateTestConfigurationRequest"}, - "output":{"shape":"CreateTestConfigurationResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a test configuration.
", - "idempotent":true - }, - "CreateTestSuite":{ - "name":"CreateTestSuite", - "http":{ - "method":"POST", - "requestUri":"/testsuite", - "responseCode":201 - }, - "input":{"shape":"CreateTestSuiteRequest"}, - "output":{"shape":"CreateTestSuiteResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a test suite.
", - "idempotent":true - }, - "DeleteTestCase":{ - "name":"DeleteTestCase", - "http":{ - "method":"DELETE", - "requestUri":"/testcases/{testCaseId}", - "responseCode":204 - }, - "input":{"shape":"DeleteTestCaseRequest"}, - "output":{"shape":"DeleteTestCaseResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes a test case.
", - "idempotent":true - }, - "DeleteTestConfiguration":{ - "name":"DeleteTestConfiguration", - "http":{ - "method":"DELETE", - "requestUri":"/testconfigurations/{testConfigurationId}", - "responseCode":204 - }, - "input":{"shape":"DeleteTestConfigurationRequest"}, - "output":{"shape":"DeleteTestConfigurationResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes a test configuration.
", - "idempotent":true - }, - "DeleteTestRun":{ - "name":"DeleteTestRun", - "http":{ - "method":"DELETE", - "requestUri":"/testruns/{testRunId}", - "responseCode":204 - }, - "input":{"shape":"DeleteTestRunRequest"}, - "output":{"shape":"DeleteTestRunResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes a test run.
", - "idempotent":true - }, - "DeleteTestSuite":{ - "name":"DeleteTestSuite", - "http":{ - "method":"DELETE", - "requestUri":"/testsuites/{testSuiteId}", - "responseCode":204 - }, - "input":{"shape":"DeleteTestSuiteRequest"}, - "output":{"shape":"DeleteTestSuiteResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes a test suite.
", - "idempotent":true - }, - "GetTestCase":{ - "name":"GetTestCase", - "http":{ - "method":"GET", - "requestUri":"/testcases/{testCaseId}", - "responseCode":200 - }, - "input":{"shape":"GetTestCaseRequest"}, - "output":{"shape":"GetTestCaseResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets a test case.
" - }, - "GetTestConfiguration":{ - "name":"GetTestConfiguration", - "http":{ - "method":"GET", - "requestUri":"/testconfigurations/{testConfigurationId}", - "responseCode":200 - }, - "input":{"shape":"GetTestConfigurationRequest"}, - "output":{"shape":"GetTestConfigurationResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets a test configuration.
" - }, - "GetTestRunStep":{ - "name":"GetTestRunStep", - "http":{ - "method":"GET", - "requestUri":"/testruns/{testRunId}/steps/{stepName}", - "responseCode":200 - }, - "input":{"shape":"GetTestRunStepRequest"}, - "output":{"shape":"GetTestRunStepResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets a test run step.
" - }, - "GetTestSuite":{ - "name":"GetTestSuite", - "http":{ - "method":"GET", - "requestUri":"/testsuites/{testSuiteId}", - "responseCode":200 - }, - "input":{"shape":"GetTestSuiteRequest"}, - "output":{"shape":"GetTestSuiteResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets a test suite.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists tags for a resource.
" - }, - "ListTestCases":{ - "name":"ListTestCases", - "http":{ - "method":"GET", - "requestUri":"/testcases", - "responseCode":200 - }, - "input":{"shape":"ListTestCasesRequest"}, - "output":{"shape":"ListTestCasesResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists test cases.
" - }, - "ListTestConfigurations":{ - "name":"ListTestConfigurations", - "http":{ - "method":"GET", - "requestUri":"/testconfigurations", - "responseCode":200 - }, - "input":{"shape":"ListTestConfigurationsRequest"}, - "output":{"shape":"ListTestConfigurationsResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists test configurations.
" - }, - "ListTestRunSteps":{ - "name":"ListTestRunSteps", - "http":{ - "method":"GET", - "requestUri":"/testruns/{testRunId}/steps", - "responseCode":200 - }, - "input":{"shape":"ListTestRunStepsRequest"}, - "output":{"shape":"ListTestRunStepsResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists test run steps.
" - }, - "ListTestRunTestCases":{ - "name":"ListTestRunTestCases", - "http":{ - "method":"GET", - "requestUri":"/testruns/{testRunId}/testcases", - "responseCode":200 - }, - "input":{"shape":"ListTestRunTestCasesRequest"}, - "output":{"shape":"ListTestRunTestCasesResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists test run test cases.
" - }, - "ListTestRuns":{ - "name":"ListTestRuns", - "http":{ - "method":"GET", - "requestUri":"/testruns", - "responseCode":200 - }, - "input":{"shape":"ListTestRunsRequest"}, - "output":{"shape":"ListTestRunsResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists test runs.
" - }, - "ListTestSuites":{ - "name":"ListTestSuites", - "http":{ - "method":"GET", - "requestUri":"/testsuites", - "responseCode":200 - }, - "input":{"shape":"ListTestSuitesRequest"}, - "output":{"shape":"ListTestSuitesResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists test suites.
" - }, - "StartTestRun":{ - "name":"StartTestRun", - "http":{ - "method":"POST", - "requestUri":"/testrun", - "responseCode":200 - }, - "input":{"shape":"StartTestRunRequest"}, - "output":{"shape":"StartTestRunResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Starts a test run.
" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Specifies tags of a resource.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Untags a resource.
", - "idempotent":true - }, - "UpdateTestCase":{ - "name":"UpdateTestCase", - "http":{ - "method":"PATCH", - "requestUri":"/testcases/{testCaseId}", - "responseCode":200 - }, - "input":{"shape":"UpdateTestCaseRequest"}, - "output":{"shape":"UpdateTestCaseResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Updates a test case.
" - }, - "UpdateTestConfiguration":{ - "name":"UpdateTestConfiguration", - "http":{ - "method":"PATCH", - "requestUri":"/testconfigurations/{testConfigurationId}", - "responseCode":200 - }, - "input":{"shape":"UpdateTestConfigurationRequest"}, - "output":{"shape":"UpdateTestConfigurationResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Updates a test configuration.
" - }, - "UpdateTestSuite":{ - "name":"UpdateTestSuite", - "http":{ - "method":"PATCH", - "requestUri":"/testsuites/{testSuiteId}", - "responseCode":200 - }, - "input":{"shape":"UpdateTestSuiteRequest"}, - "output":{"shape":"UpdateTestSuiteResponse"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Updates a test suite.
" - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"The account or role doesn't have the right permissions to make the request.
", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "Arn":{ - "type":"string", - "pattern":"arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}" - }, - "Batch":{ - "type":"structure", - "required":["batchJobName"], - "members":{ - "batchJobName":{ - "shape":"Variable", - "documentation":"The job name of the batch.
" - }, - "batchJobParameters":{ - "shape":"BatchJobParameters", - "documentation":"The batch job parameters of the batch.
" - }, - "exportDataSetNames":{ - "shape":"ExportDataSetNames", - "documentation":"The export data set names of the batch.
" - } - }, - "documentation":"Defines a batch.
" - }, - "BatchJobParameters":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "BatchStepInput":{ - "type":"structure", - "required":[ - "resource", - "batchJobName" - ], - "members":{ - "resource":{ - "shape":"MainframeResourceSummary", - "documentation":"The resource of the batch step input.
" - }, - "batchJobName":{ - "shape":"ResourceName", - "documentation":"The batch job name of the batch step input.
" - }, - "batchJobParameters":{ - "shape":"BatchJobParameters", - "documentation":"The batch job parameters of the batch step input.
" - }, - "exportDataSetNames":{ - "shape":"ExportDataSetNames", - "documentation":"The export data set names of the batch step input.
" - }, - "properties":{ - "shape":"MainframeActionProperties", - "documentation":"The properties of the batch step input.
" - } - }, - "documentation":"Defines a batch step input.
" - }, - "BatchStepOutput":{ - "type":"structure", - "members":{ - "dataSetExportLocation":{ - "shape":"S3Uri", - "documentation":"The data set export location of the batch step output.
" - }, - "dmsOutputLocation":{ - "shape":"S3Uri", - "documentation":"The Database Migration Service (DMS) output location of the batch step output.
" - }, - "dataSetDetails":{ - "shape":"DataSetList", - "documentation":"The data set details of the batch step output.
" - } - }, - "documentation":"Defines a batch step output.
" - }, - "BatchSummary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"BatchStepInput", - "documentation":"The step input of the batch summary.
" - }, - "stepOutput":{ - "shape":"BatchStepOutput", - "documentation":"The step output of the batch summary.
" - } - }, - "documentation":"Summarizes a batch job.
" - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "CaptureTool":{ - "type":"string", - "enum":[ - "Precisely", - "AWS DMS" - ] - }, - "CloudFormation":{ - "type":"structure", - "required":["templateLocation"], - "members":{ - "templateLocation":{ - "shape":"S3Uri", - "documentation":"The template location of the CloudFormation template.
" - }, - "parameters":{ - "shape":"Properties", - "documentation":"The CloudFormation properties in the CloudFormation template.
" - } - }, - "documentation":"Specifies the CloudFormation template and its parameters.
" - }, - "CloudFormationAction":{ - "type":"structure", - "required":["resource"], - "members":{ - "resource":{ - "shape":"Variable", - "documentation":"The resource of the CloudFormation action.
" - }, - "actionType":{ - "shape":"CloudFormationActionType", - "documentation":"The action type of the CloudFormation action.
" - } - }, - "documentation":"Specifies the CloudFormation action.
" - }, - "CloudFormationActionType":{ - "type":"string", - "enum":[ - "Create", - "Delete" - ] - }, - "CloudFormationStepSummary":{ - "type":"structure", - "members":{ - "createCloudformation":{ - "shape":"CreateCloudFormationSummary", - "documentation":"Creates the CloudFormation summary of the step.
" - }, - "deleteCloudformation":{ - "shape":"DeleteCloudFormationSummary", - "documentation":"Deletes the CloudFormation summary of the CloudFormation step summary.
" - } - }, - "documentation":"Specifies the CloudFormation step summary.
", - "union":true - }, - "CompareAction":{ - "type":"structure", - "required":["input"], - "members":{ - "input":{ - "shape":"Input", - "documentation":"The input of the compare action.
" - }, - "output":{ - "shape":"Output", - "documentation":"The output of the compare action.
" - } - }, - "documentation":"Compares the action.
" - }, - "CompareActionSummary":{ - "type":"structure", - "required":["type"], - "members":{ - "type":{ - "shape":"File", - "documentation":"The type of the compare action summary.
" - } - }, - "documentation":"Specifies the compare action summary.
" - }, - "CompareDataSetsStepInput":{ - "type":"structure", - "required":[ - "sourceLocation", - "targetLocation", - "sourceDataSets", - "targetDataSets" - ], - "members":{ - "sourceLocation":{ - "shape":"S3Uri", - "documentation":"The source location of the compare data sets step input location.
" - }, - "targetLocation":{ - "shape":"S3Uri", - "documentation":"The target location of the compare data sets step input location.
" - }, - "sourceDataSets":{ - "shape":"DataSetList", - "documentation":"The source data sets of the compare data sets step input location.
" - }, - "targetDataSets":{ - "shape":"DataSetList", - "documentation":"The target data sets of the compare data sets step input location.
" - } - }, - "documentation":"Specifies the compare data sets step input.
" - }, - "CompareDataSetsStepOutput":{ - "type":"structure", - "required":[ - "comparisonOutputLocation", - "comparisonStatus" - ], - "members":{ - "comparisonOutputLocation":{ - "shape":"S3Uri", - "documentation":"The comparison output location of the compare data sets step output.
" - }, - "comparisonStatus":{ - "shape":"ComparisonStatusEnum", - "documentation":"The comparison status of the compare data sets step output.
" - } - }, - "documentation":"Specifies the compare data sets step output.
" - }, - "CompareDataSetsSummary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"CompareDataSetsStepInput", - "documentation":"The step input of the compare data sets summary.
" - }, - "stepOutput":{ - "shape":"CompareDataSetsStepOutput", - "documentation":"The step output of the compare data sets summary.
" - } - }, - "documentation":"Compares data sets summary.
" - }, - "CompareDatabaseCDCStepInput":{ - "type":"structure", - "required":[ - "sourceLocation", - "targetLocation", - "sourceMetadata", - "targetMetadata" - ], - "members":{ - "sourceLocation":{ - "shape":"String", - "documentation":"The source location of the compare database CDC step input.
" - }, - "targetLocation":{ - "shape":"String", - "documentation":"The target location of the compare database CDC step input.
" - }, - "outputLocation":{ - "shape":"String", - "documentation":"The output location of the compare database CDC step input.
" - }, - "sourceMetadata":{ - "shape":"SourceDatabaseMetadata", - "documentation":"The source metadata of the compare database CDC step input.
" - }, - "targetMetadata":{ - "shape":"TargetDatabaseMetadata", - "documentation":"The target metadata location of the compare database CDC step input.
" - } - }, - "documentation":"Compares the database Change Data Capture (CDC) step input.
" - }, - "CompareDatabaseCDCStepOutput":{ - "type":"structure", - "required":[ - "comparisonOutputLocation", - "comparisonStatus" - ], - "members":{ - "comparisonOutputLocation":{ - "shape":"String", - "documentation":"The comparison output of the compare database CDC step output.
" - }, - "comparisonStatus":{ - "shape":"ComparisonStatusEnum", - "documentation":"The comparison status of the compare database CDC step output.
" - } - }, - "documentation":"Compares the database CDC step output.
" - }, - "CompareDatabaseCDCSummary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"CompareDatabaseCDCStepInput", - "documentation":"The step input of the compare database CDC summary.
" - }, - "stepOutput":{ - "shape":"CompareDatabaseCDCStepOutput", - "documentation":"The step output of the compare database CDC summary.
" - } - }, - "documentation":"Compares the database CDC summary.
" - }, - "CompareFileType":{ - "type":"structure", - "members":{ - "datasets":{ - "shape":"CompareDataSetsSummary", - "documentation":"The data sets in the compare file type.
" - }, - "databaseCDC":{ - "shape":"CompareDatabaseCDCSummary", - "documentation":"The database CDC of the compare file type.
" - } - }, - "documentation":"Compares the file type.
", - "union":true - }, - "ComparisonStatusEnum":{ - "type":"string", - "enum":[ - "Different", - "Equivalent", - "Equal" - ] - }, - "ConflictException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "resourceId":{ - "shape":"String", - "documentation":"The resource ID of the conflicts with existing resources.
" - }, - "resourceType":{ - "shape":"String", - "documentation":"The resource type of the conflicts with existing resources.
" - } - }, - "documentation":"The parameters provided in the request conflict with existing resources.
", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CreateCloudFormationStepInput":{ - "type":"structure", - "required":["templateLocation"], - "members":{ - "templateLocation":{ - "shape":"S3Uri", - "documentation":"The template location of the CloudFormation step input.
" - }, - "parameters":{ - "shape":"Properties", - "documentation":"The CloudFormation properties of the CloudFormation step input.
" - } - }, - "documentation":"Creates the CloudFormation step input.
" - }, - "CreateCloudFormationStepOutput":{ - "type":"structure", - "required":["stackId"], - "members":{ - "stackId":{ - "shape":"String", - "documentation":"The stack ID of the CloudFormation step output.
" - }, - "exports":{ - "shape":"Properties", - "documentation":"The exports of the CloudFormation step output.
" - } - }, - "documentation":"Creates a CloudFormation step output.
" - }, - "CreateCloudFormationSummary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"CreateCloudFormationStepInput", - "documentation":"The step input of the CloudFormation summary.
" - }, - "stepOutput":{ - "shape":"CreateCloudFormationStepOutput", - "documentation":"The step output of the CloudFormation summary.
" - } - }, - "documentation":"Creates a CloudFormation summary.
" - }, - "CreateTestCaseRequest":{ - "type":"structure", - "required":[ - "name", - "steps" - ], - "members":{ - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test case.
" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test case.
" - }, - "steps":{ - "shape":"StepList", - "documentation":"The steps in the test case.
" - }, - "clientToken":{ - "shape":"IdempotencyTokenString", - "documentation":"The client token of the test case.
", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagMap", - "documentation":"The specified tags of the test case.
" - } - } - }, - "CreateTestCaseResponse":{ - "type":"structure", - "required":[ - "testCaseId", - "testCaseVersion" - ], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test case.
" - }, - "testCaseVersion":{ - "shape":"Version", - "documentation":"The test case version of the test case.
" - } - } - }, - "CreateTestConfigurationRequest":{ - "type":"structure", - "required":[ - "name", - "resources" - ], - "members":{ - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test configuration.
" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test configuration.
" - }, - "resources":{ - "shape":"ResourceList", - "documentation":"The defined resources of the test configuration.
" - }, - "properties":{ - "shape":"Properties", - "documentation":"The properties of the test configuration.
" - }, - "clientToken":{ - "shape":"IdempotencyTokenString", - "documentation":"The client token of the test configuration.
", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the test configuration.
" - }, - "serviceSettings":{ - "shape":"ServiceSettings", - "documentation":"The service settings of the test configuration.
" - } - } - }, - "CreateTestConfigurationResponse":{ - "type":"structure", - "required":[ - "testConfigurationId", - "testConfigurationVersion" - ], - "members":{ - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The test configuration ID.
" - }, - "testConfigurationVersion":{ - "shape":"Version", - "documentation":"The test configuration version.
" - } - } - }, - "CreateTestSuiteRequest":{ - "type":"structure", - "required":[ - "name", - "testCases" - ], - "members":{ - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test suite.
" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test suite.
" - }, - "beforeSteps":{ - "shape":"StepList", - "documentation":"The before steps of the test suite.
" - }, - "afterSteps":{ - "shape":"StepList", - "documentation":"The after steps of the test suite.
" - }, - "testCases":{ - "shape":"TestCases", - "documentation":"The test cases in the test suite.
" - }, - "clientToken":{ - "shape":"IdempotencyTokenString", - "documentation":"The client token of the test suite.
", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the test suite.
" - } - } - }, - "CreateTestSuiteResponse":{ - "type":"structure", - "required":[ - "testSuiteId", - "testSuiteVersion" - ], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The suite ID of the test suite.
" - }, - "testSuiteVersion":{ - "shape":"Version", - "documentation":"The suite version of the test suite.
" - } - } - }, - "DataSet":{ - "type":"structure", - "required":[ - "type", - "name", - "ccsid", - "format", - "length" - ], - "members":{ - "type":{ - "shape":"DataSetType", - "documentation":"The type of the data set.
" - }, - "name":{ - "shape":"String100", - "documentation":"The name of the data set.
" - }, - "ccsid":{ - "shape":"String50", - "documentation":"The CCSID of the data set.
" - }, - "format":{ - "shape":"Format", - "documentation":"The format of the data set.
" - }, - "length":{ - "shape":"Integer", - "documentation":"The length of the data set.
" - } - }, - "documentation":"Defines a data set.
" - }, - "DataSetList":{ - "type":"list", - "member":{"shape":"DataSet"} - }, - "DataSetType":{ - "type":"string", - "enum":["PS"] - }, - "DatabaseCDC":{ - "type":"structure", - "required":[ - "sourceMetadata", - "targetMetadata" - ], - "members":{ - "sourceMetadata":{ - "shape":"SourceDatabaseMetadata", - "documentation":"The source metadata of the database CDC.
" - }, - "targetMetadata":{ - "shape":"TargetDatabaseMetadata", - "documentation":"The target metadata of the database CDC.
" - } - }, - "documentation":"Defines the Change Data Capture (CDC) of the database.
" - }, - "DeleteCloudFormationStepInput":{ - "type":"structure", - "required":["stackId"], - "members":{ - "stackId":{ - "shape":"String", - "documentation":"The stack ID of the deleted CloudFormation step input.
" - } - }, - "documentation":"Deletes the CloudFormation step input.
" - }, - "DeleteCloudFormationStepOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"Deletes the CloudFormation summary step output.
" - }, - "DeleteCloudFormationSummary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"DeleteCloudFormationStepInput", - "documentation":"The step input of the deleted CloudFormation summary.
" - }, - "stepOutput":{ - "shape":"DeleteCloudFormationStepOutput", - "documentation":"The step output of the deleted CloudFormation summary.
" - } - }, - "documentation":"Deletes the CloudFormation summary.
" - }, - "DeleteTestCaseRequest":{ - "type":"structure", - "required":["testCaseId"], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test case.
", - "location":"uri", - "locationName":"testCaseId" - } - } - }, - "DeleteTestCaseResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteTestConfigurationRequest":{ - "type":"structure", - "required":["testConfigurationId"], - "members":{ - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The test ID of the test configuration.
", - "location":"uri", - "locationName":"testConfigurationId" - } - } - }, - "DeleteTestConfigurationResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteTestRunRequest":{ - "type":"structure", - "required":["testRunId"], - "members":{ - "testRunId":{ - "shape":"Identifier", - "documentation":"The run ID of the test run.
", - "location":"uri", - "locationName":"testRunId" - } - } - }, - "DeleteTestRunResponse":{ - "type":"structure", - "members":{ - } - }, - "DeleteTestSuiteRequest":{ - "type":"structure", - "required":["testSuiteId"], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test ID of the test suite.
", - "location":"uri", - "locationName":"testSuiteId" - } - } - }, - "DeleteTestSuiteResponse":{ - "type":"structure", - "members":{ - } - }, - "ExportDataSetNames":{ - "type":"list", - "member":{"shape":"String100"} - }, - "File":{ - "type":"structure", - "members":{ - "fileType":{ - "shape":"CompareFileType", - "documentation":"The file type of the file.
" - } - }, - "documentation":"Defines a file.
", - "union":true - }, - "FileMetadata":{ - "type":"structure", - "members":{ - "dataSets":{ - "shape":"DataSetList", - "documentation":"The data sets of the file metadata.
" - }, - "databaseCDC":{ - "shape":"DatabaseCDC", - "documentation":"The database CDC of the file metadata.
" - } - }, - "documentation":"Specifies a file metadata.
", - "union":true - }, - "Format":{ - "type":"string", - "enum":[ - "FIXED", - "VARIABLE", - "LINE_SEQUENTIAL" - ] - }, - "GetTestCaseRequest":{ - "type":"structure", - "required":["testCaseId"], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The request test ID of the test case.
", - "location":"uri", - "locationName":"testCaseId" - }, - "testCaseVersion":{ - "shape":"Version", - "documentation":"The test case version of the test case.
", - "location":"querystring", - "locationName":"testCaseVersion" - } - } - }, - "GetTestCaseResponse":{ - "type":"structure", - "required":[ - "testCaseId", - "testCaseArn", - "name", - "latestVersion", - "testCaseVersion", - "status", - "creationTime", - "lastUpdateTime", - "steps" - ], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The response test ID of the test case.
" - }, - "testCaseArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the test case.
" - }, - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test case.
" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test case.
" - }, - "latestVersion":{ - "shape":"TestCaseLatestVersion", - "documentation":"The latest version of the test case.
" - }, - "testCaseVersion":{ - "shape":"Version", - "documentation":"The case version of the test case.
" - }, - "status":{ - "shape":"TestCaseLifecycle", - "documentation":"The status of the test case.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test case.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The creation time of the test case.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last update time of the test case.
" - }, - "steps":{ - "shape":"StepList", - "documentation":"The steps of the test case.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the test case.
" - } - } - }, - "GetTestConfigurationRequest":{ - "type":"structure", - "required":["testConfigurationId"], - "members":{ - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The request test configuration ID.
", - "location":"uri", - "locationName":"testConfigurationId" - }, - "testConfigurationVersion":{ - "shape":"Version", - "documentation":"The test configuration version.
", - "location":"querystring", - "locationName":"testConfigurationVersion" - } - } - }, - "GetTestConfigurationResponse":{ - "type":"structure", - "required":[ - "testConfigurationId", - "name", - "testConfigurationArn", - "latestVersion", - "testConfigurationVersion", - "status", - "creationTime", - "lastUpdateTime", - "resources", - "properties" - ], - "members":{ - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The response test configuration ID.
" - }, - "name":{ - "shape":"ResourceName", - "documentation":"The test configuration name
" - }, - "testConfigurationArn":{ - "shape":"Arn", - "documentation":"The test configuration Amazon Resource Name (ARN).
" - }, - "latestVersion":{ - "shape":"TestConfigurationLatestVersion", - "documentation":"The latest version of the test configuration.
" - }, - "testConfigurationVersion":{ - "shape":"Version", - "documentation":"The test configuration version.
" - }, - "status":{ - "shape":"TestConfigurationLifecycle", - "documentation":"The status of the test configuration.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test configuration.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The creation time of the test configuration.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last update time of the test configuration.
" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test configuration.
" - }, - "resources":{ - "shape":"ResourceList", - "documentation":"The resources of the test configuration.
" - }, - "properties":{ - "shape":"Properties", - "documentation":"The properties of the test configuration.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the test configuration.
" - }, - "serviceSettings":{ - "shape":"ServiceSettings", - "documentation":"The service settings of the test configuration.
" - } - } - }, - "GetTestRunStepRequest":{ - "type":"structure", - "required":[ - "testRunId", - "stepName" - ], - "members":{ - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run ID of the test run step.
", - "location":"uri", - "locationName":"testRunId" - }, - "stepName":{ - "shape":"ResourceName", - "documentation":"The step name of the test run step.
", - "location":"uri", - "locationName":"stepName" - }, - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of a test run step.
", - "location":"querystring", - "locationName":"testCaseId" - }, - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of a test run step.
", - "location":"querystring", - "locationName":"testSuiteId" - } - } - }, - "GetTestRunStepResponse":{ - "type":"structure", - "required":[ - "stepName", - "testRunId", - "status", - "runStartTime" - ], - "members":{ - "stepName":{ - "shape":"ResourceName", - "documentation":"The step name of the test run step.
" - }, - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run ID of the test run step.
" - }, - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test run step.
" - }, - "testCaseVersion":{ - "shape":"Version", - "documentation":"The test case version of the test run step.
" - }, - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test run step.
" - }, - "testSuiteVersion":{ - "shape":"Version", - "documentation":"The test suite version of the test run step.
" - }, - "beforeStep":{ - "shape":"Boolean", - "documentation":"The before steps of the test run step.
" - }, - "afterStep":{ - "shape":"Boolean", - "documentation":"The after steps of the test run step.
" - }, - "status":{ - "shape":"StepRunStatus", - "documentation":"The status of the test run step.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test run step.
" - }, - "runStartTime":{ - "shape":"Timestamp", - "documentation":"The run start time of the test run step.
" - }, - "runEndTime":{ - "shape":"Timestamp", - "documentation":"The run end time of the test run step.
" - }, - "stepRunSummary":{ - "shape":"StepRunSummary", - "documentation":"The step run summary of the test run step.
" - } - } - }, - "GetTestSuiteRequest":{ - "type":"structure", - "required":["testSuiteId"], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The ID of the test suite.
", - "location":"uri", - "locationName":"testSuiteId" - }, - "testSuiteVersion":{ - "shape":"Version", - "documentation":"The version of the test suite.
", - "location":"querystring", - "locationName":"testSuiteVersion" - } - } - }, - "GetTestSuiteResponse":{ - "type":"structure", - "required":[ - "testSuiteId", - "name", - "latestVersion", - "testSuiteVersion", - "testSuiteArn", - "creationTime", - "lastUpdateTime", - "beforeSteps", - "afterSteps", - "testCases" - ], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The response ID of the test suite.
" - }, - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test suite.
" - }, - "latestVersion":{ - "shape":"TestSuiteLatestVersion", - "documentation":"The latest version of the test suite.
" - }, - "testSuiteVersion":{ - "shape":"Version", - "documentation":"The version of the test suite.
" - }, - "status":{ - "shape":"TestSuiteLifecycle", - "documentation":"The status of the test suite.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test suite.
" - }, - "testSuiteArn":{ - "shape":"Arn", - "documentation":"The test suite Amazon Resource Name (ARN).
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The creation time of the test suite.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last update time of the test suite.
" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test suite.
" - }, - "beforeSteps":{ - "shape":"StepList", - "documentation":"The before steps of the test suite.
" - }, - "afterSteps":{ - "shape":"StepList", - "documentation":"The after steps of the test suite.
" - }, - "testCases":{ - "shape":"TestCases", - "documentation":"The test cases of the test suite.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the test suite.
" - } - } - }, - "IdempotencyTokenString":{ - "type":"string", - "pattern":"[A-Za-z0-9\\-]{1,64}" - }, - "Identifier":{ - "type":"string", - "pattern":"[A-Za-z0-9:/\\-]{1,100}" - }, - "Input":{ - "type":"structure", - "members":{ - "file":{ - "shape":"InputFile", - "documentation":"The file in the input.
" - } - }, - "documentation":"Specifies the input.
", - "union":true - }, - "InputFile":{ - "type":"structure", - "required":[ - "sourceLocation", - "targetLocation", - "fileMetadata" - ], - "members":{ - "sourceLocation":{ - "shape":"Variable", - "documentation":"The source location of the input file.
" - }, - "targetLocation":{ - "shape":"Variable", - "documentation":"The target location of the input file.
" - }, - "fileMetadata":{ - "shape":"FileMetadata", - "documentation":"The file metadata of the input file.
" - } - }, - "documentation":"Specifies the input file.
" - }, - "Integer":{ - "type":"integer", - "box":true - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "retryAfterSeconds":{ - "shape":"Integer", - "documentation":"The number of seconds to retry the query.
", - "location":"header", - "locationName":"Retry-After" - } - }, - "documentation":"An unexpected error occurred during the processing of the request.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "retryable":{"throttling":false} - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the resource.
", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "required":["tags"], - "members":{ - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the resource.
" - } - } - }, - "ListTestCasesRequest":{ - "type":"structure", - "members":{ - "testCaseIds":{ - "shape":"TestCaseIdList", - "documentation":"The IDs of the test cases.
", - "location":"querystring", - "locationName":"testCaseIds" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The next token of the test cases.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum results of the test case.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListTestCasesResponse":{ - "type":"structure", - "required":["testCases"], - "members":{ - "testCases":{ - "shape":"TestCaseSummaryList", - "documentation":"The test cases in an application.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The next token in test cases.
" - } - } - }, - "ListTestConfigurationsRequest":{ - "type":"structure", - "members":{ - "testConfigurationIds":{ - "shape":"TestConfigurationIdList", - "documentation":"The configuration IDs of the test configurations.
", - "location":"querystring", - "locationName":"testConfigurationIds" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The next token for the test configurations.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum results of the test configuration.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListTestConfigurationsResponse":{ - "type":"structure", - "required":["testConfigurations"], - "members":{ - "testConfigurations":{ - "shape":"TestConfigurationList", - "documentation":"The test configurations.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The next token in the test configurations.
" - } - } - }, - "ListTestRunStepsRequest":{ - "type":"structure", - "required":["testRunId"], - "members":{ - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run ID of the test run steps.
", - "location":"uri", - "locationName":"testRunId" - }, - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test run steps.
", - "location":"querystring", - "locationName":"testCaseId" - }, - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test run steps.
", - "location":"querystring", - "locationName":"testSuiteId" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from a previous step to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of test run steps to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListTestRunStepsResponse":{ - "type":"structure", - "required":["testRunSteps"], - "members":{ - "testRunSteps":{ - "shape":"TestRunStepSummaryList", - "documentation":"The test run steps of the response query.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from a previous request to retrieve the next page of results.
" - } - } - }, - "ListTestRunTestCasesRequest":{ - "type":"structure", - "required":["testRunId"], - "members":{ - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run ID of the test cases.
", - "location":"uri", - "locationName":"testRunId" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of test run test cases to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListTestRunTestCasesResponse":{ - "type":"structure", - "required":["testRunTestCases"], - "members":{ - "testRunTestCases":{ - "shape":"TestCaseRunSummaryList", - "documentation":"The test run of the test cases.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from a previous request to retrieve the next page of results.
" - } - } - }, - "ListTestRunsRequest":{ - "type":"structure", - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test runs.
", - "location":"querystring", - "locationName":"testSuiteId" - }, - "testRunIds":{ - "shape":"TestRunIdList", - "documentation":"The test run IDs of the test runs.
", - "location":"querystring", - "locationName":"testrunIds" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from the previous request to retrieve the next page of test run results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of test runs to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListTestRunsResponse":{ - "type":"structure", - "required":["testRuns"], - "members":{ - "testRuns":{ - "shape":"TestRunSummaryList", - "documentation":"The test runs of the response query.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from the previous request to retrieve the next page of results.
" - } - } - }, - "ListTestSuitesRequest":{ - "type":"structure", - "members":{ - "testSuiteIds":{ - "shape":"TestSuiteIdList", - "documentation":"The suite ID of the test suites.
", - "location":"querystring", - "locationName":"testSuiteIds" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of test suites to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListTestSuitesResponse":{ - "type":"structure", - "required":["testSuites"], - "members":{ - "testSuites":{ - "shape":"TestSuiteList", - "documentation":"The test suites returned with the response query.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token from a previous request to retrieve the next page of test suites results.
" - } - } - }, - "M2ManagedActionProperties":{ - "type":"structure", - "members":{ - "forceStop":{ - "shape":"Boolean", - "documentation":"Force stops the AWS Mainframe Modernization managed action properties.
" - }, - "importDataSetLocation":{ - "shape":"Variable", - "documentation":"The import data set location of the AWS Mainframe Modernization managed action properties.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization managed action properties.
" - }, - "M2ManagedActionType":{ - "type":"string", - "enum":[ - "Configure", - "Deconfigure" - ] - }, - "M2ManagedApplication":{ - "type":"structure", - "required":[ - "applicationId", - "runtime" - ], - "members":{ - "applicationId":{ - "shape":"Variable", - "documentation":"The application ID of the AWS Mainframe Modernization managed application.
" - }, - "runtime":{ - "shape":"M2ManagedRuntime", - "documentation":"The runtime of the AWS Mainframe Modernization managed application.
" - }, - "vpcEndpointServiceName":{ - "shape":"Variable", - "documentation":"The VPC endpoint service name of the AWS Mainframe Modernization managed application.
" - }, - "listenerPort":{ - "shape":"Variable", - "documentation":"The listener port of the AWS Mainframe Modernization managed application.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization managed application.
" - }, - "M2ManagedApplicationAction":{ - "type":"structure", - "required":[ - "resource", - "actionType" - ], - "members":{ - "resource":{ - "shape":"Variable", - "documentation":"The resource of the AWS Mainframe Modernization managed application action.
" - }, - "actionType":{ - "shape":"M2ManagedActionType", - "documentation":"The action type of the AWS Mainframe Modernization managed application action.
" - }, - "properties":{ - "shape":"M2ManagedActionProperties", - "documentation":"The properties of the AWS Mainframe Modernization managed application action.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization managed application action.
" - }, - "M2ManagedApplicationStepInput":{ - "type":"structure", - "required":[ - "applicationId", - "runtime", - "actionType" - ], - "members":{ - "applicationId":{ - "shape":"String", - "documentation":"The application ID of the AWS Mainframe Modernization managed application step input.
" - }, - "runtime":{ - "shape":"String", - "documentation":"The runtime of the AWS Mainframe Modernization managed application step input.
" - }, - "vpcEndpointServiceName":{ - "shape":"String", - "documentation":"The VPC endpoint service name of the AWS Mainframe Modernization managed application step input.
" - }, - "listenerPort":{ - "shape":"Integer", - "documentation":"The listener port of the AWS Mainframe Modernization managed application step input.
" - }, - "actionType":{ - "shape":"M2ManagedActionType", - "documentation":"The action type of the AWS Mainframe Modernization managed application step input.
" - }, - "properties":{ - "shape":"M2ManagedActionProperties", - "documentation":"The properties of the AWS Mainframe Modernization managed application step input.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization managed application step input.
" - }, - "M2ManagedApplicationStepOutput":{ - "type":"structure", - "members":{ - "importDataSetSummary":{ - "shape":"Properties", - "documentation":"The import data set summary of the AWS Mainframe Modernization managed application step output.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization managed application step output.
" - }, - "M2ManagedApplicationStepSummary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"M2ManagedApplicationStepInput", - "documentation":"The step input of the AWS Mainframe Modernization managed application step summary.
" - }, - "stepOutput":{ - "shape":"M2ManagedApplicationStepOutput", - "documentation":"The step output of the AWS Mainframe Modernization managed application step summary.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization managed application step summary.
" - }, - "M2ManagedApplicationSummary":{ - "type":"structure", - "required":[ - "applicationId", - "runtime" - ], - "members":{ - "applicationId":{ - "shape":"Identifier", - "documentation":"The application ID of the AWS Mainframe Modernization managed application summary.
" - }, - "runtime":{ - "shape":"M2ManagedRuntime", - "documentation":"The runtime of the AWS Mainframe Modernization managed application summary.
" - }, - "listenerPort":{ - "shape":"Integer", - "documentation":"The listener port of the AWS Mainframe Modernization managed application summary.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization managed application summary.
" - }, - "M2ManagedRuntime":{ - "type":"string", - "enum":["MicroFocus"] - }, - "M2NonManagedActionType":{ - "type":"string", - "enum":[ - "Configure", - "Deconfigure" - ] - }, - "M2NonManagedApplication":{ - "type":"structure", - "required":[ - "vpcEndpointServiceName", - "listenerPort", - "runtime" - ], - "members":{ - "vpcEndpointServiceName":{ - "shape":"Variable", - "documentation":"The VPC endpoint service name of the AWS Mainframe Modernization non-managed application.
" - }, - "listenerPort":{ - "shape":"Variable", - "documentation":"The listener port of the AWS Mainframe Modernization non-managed application.
" - }, - "runtime":{ - "shape":"M2NonManagedRuntime", - "documentation":"The runtime of the AWS Mainframe Modernization non-managed application.
" - }, - "webAppName":{ - "shape":"Variable", - "documentation":"The web application name of the AWS Mainframe Modernization non-managed application.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization non-managed application.
" - }, - "M2NonManagedApplicationAction":{ - "type":"structure", - "required":[ - "resource", - "actionType" - ], - "members":{ - "resource":{ - "shape":"Variable", - "documentation":"The resource of the AWS Mainframe Modernization non-managed application action.
" - }, - "actionType":{ - "shape":"M2NonManagedActionType", - "documentation":"The action type of the AWS Mainframe Modernization non-managed application action.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization non-managed application action.
" - }, - "M2NonManagedApplicationStepInput":{ - "type":"structure", - "required":[ - "vpcEndpointServiceName", - "listenerPort", - "runtime", - "actionType" - ], - "members":{ - "vpcEndpointServiceName":{ - "shape":"String", - "documentation":"The VPC endpoint service name of the AWS Mainframe Modernization non-managed application step input.
" - }, - "listenerPort":{ - "shape":"Integer", - "documentation":"The listener port of the AWS Mainframe Modernization non-managed application step input.
" - }, - "runtime":{ - "shape":"M2NonManagedRuntime", - "documentation":"The runtime of the AWS Mainframe Modernization non-managed application step input.
" - }, - "webAppName":{ - "shape":"String", - "documentation":"The web app name of the AWS Mainframe Modernization non-managed application step input.
" - }, - "actionType":{ - "shape":"M2NonManagedActionType", - "documentation":"The action type of the AWS Mainframe Modernization non-managed application step input.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization non-managed application step input.
" - }, - "M2NonManagedApplicationStepOutput":{ - "type":"structure", - "members":{ - }, - "documentation":"Specifies the AWS Mainframe Modernization non-managed application step output.
" - }, - "M2NonManagedApplicationStepSummary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"M2NonManagedApplicationStepInput", - "documentation":"The step input of the AWS Mainframe Modernization non-managed application step summary.
" - }, - "stepOutput":{ - "shape":"M2NonManagedApplicationStepOutput", - "documentation":"The step output of the AWS Mainframe Modernization non-managed application step summary.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization non-managed application step summary.
" - }, - "M2NonManagedApplicationSummary":{ - "type":"structure", - "required":[ - "vpcEndpointServiceName", - "listenerPort", - "runtime" - ], - "members":{ - "vpcEndpointServiceName":{ - "shape":"String", - "documentation":"The VPC endpoint service name of the AWS Mainframe Modernization non-managed application summary.
" - }, - "listenerPort":{ - "shape":"Integer", - "documentation":"The listener port of the AWS Mainframe Modernization non-managed application summary.
" - }, - "runtime":{ - "shape":"M2NonManagedRuntime", - "documentation":"The runtime of the AWS Mainframe Modernization non-managed application summary.
" - }, - "webAppName":{ - "shape":"String", - "documentation":"The web application name of the AWS Mainframe Modernization non-managed application summary.
" - } - }, - "documentation":"Specifies the AWS Mainframe Modernization non-managed application summary.
" - }, - "M2NonManagedRuntime":{ - "type":"string", - "enum":["BluAge"] - }, - "MainframeAction":{ - "type":"structure", - "required":[ - "resource", - "actionType" - ], - "members":{ - "resource":{ - "shape":"Variable", - "documentation":"The resource of the mainframe action.
" - }, - "actionType":{ - "shape":"MainframeActionType", - "documentation":"The action type of the mainframe action.
" - }, - "properties":{ - "shape":"MainframeActionProperties", - "documentation":"The properties of the mainframe action.
" - } - }, - "documentation":"Specifies the mainframe action.
" - }, - "MainframeActionProperties":{ - "type":"structure", - "members":{ - "dmsTaskArn":{ - "shape":"Variable", - "documentation":"The DMS task ARN of the mainframe action properties.
" - } - }, - "documentation":"Specifies the mainframe action properties.
" - }, - "MainframeActionSummary":{ - "type":"structure", - "members":{ - "batch":{ - "shape":"BatchSummary", - "documentation":"The batch of the mainframe action summary.
" - }, - "tn3270":{ - "shape":"TN3270Summary", - "documentation":"The tn3270 port of the mainframe action summary.
" - } - }, - "documentation":"Specifies the mainframe action summary.
", - "union":true - }, - "MainframeActionType":{ - "type":"structure", - "members":{ - "batch":{ - "shape":"Batch", - "documentation":"The batch of the mainframe action type.
" - }, - "tn3270":{ - "shape":"TN3270", - "documentation":"The tn3270 port of the mainframe action type.
" - } - }, - "documentation":"Specifies the mainframe action type.
", - "union":true - }, - "MainframeResourceSummary":{ - "type":"structure", - "members":{ - "m2ManagedApplication":{ - "shape":"M2ManagedApplicationSummary", - "documentation":"The AWS Mainframe Modernization managed application in the mainframe resource summary.
" - }, - "m2NonManagedApplication":{ - "shape":"M2NonManagedApplicationSummary", - "documentation":"The AWS Mainframe Modernization non-managed application in the mainframe resource summary.
" - } - }, - "documentation":"Specifies the mainframe resource summary.
", - "union":true - }, - "MaxResults":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "NextToken":{ - "type":"string", - "pattern":"\\S{1,2000}" - }, - "Output":{ - "type":"structure", - "members":{ - "file":{ - "shape":"OutputFile", - "documentation":"The file of the output.
" - } - }, - "documentation":"Specifies an output.
", - "union":true - }, - "OutputFile":{ - "type":"structure", - "members":{ - "fileLocation":{ - "shape":"S3Uri", - "documentation":"The file location of the output file.
" - } - }, - "documentation":"Specifies an output file.
" - }, - "Properties":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "Resource":{ - "type":"structure", - "required":[ - "name", - "type" - ], - "members":{ - "name":{ - "shape":"ResourceName", - "documentation":"The name of the resource.
" - }, - "type":{ - "shape":"ResourceType", - "documentation":"The type of the resource.
" - } - }, - "documentation":"Specifies a resource.
" - }, - "ResourceAction":{ - "type":"structure", - "members":{ - "m2ManagedApplicationAction":{ - "shape":"M2ManagedApplicationAction", - "documentation":"The AWS Mainframe Modernization managed application action of the resource action.
" - }, - "m2NonManagedApplicationAction":{ - "shape":"M2NonManagedApplicationAction", - "documentation":"The AWS Mainframe Modernization non-managed application action of the resource action.
" - }, - "cloudFormationAction":{ - "shape":"CloudFormationAction", - "documentation":"The CloudFormation action of the resource action.
" - } - }, - "documentation":"Specifies a resource action.
", - "union":true - }, - "ResourceActionSummary":{ - "type":"structure", - "members":{ - "cloudFormation":{ - "shape":"CloudFormationStepSummary", - "documentation":"The CloudFormation template of the resource action summary.
" - }, - "m2ManagedApplication":{ - "shape":"M2ManagedApplicationStepSummary", - "documentation":"The AWS Mainframe Modernization managed application of the resource action summary.
" - }, - "m2NonManagedApplication":{ - "shape":"M2NonManagedApplicationStepSummary", - "documentation":"The AWS Mainframe Modernization non-managed application of the resource action summary.
" - } - }, - "documentation":"Specifies the resource action summary.
", - "union":true - }, - "ResourceDescription":{ - "type":"string", - "max":1000, - "min":0 - }, - "ResourceList":{ - "type":"list", - "member":{"shape":"Resource"}, - "max":20, - "min":1 - }, - "ResourceName":{ - "type":"string", - "pattern":"[A-Za-z][A-Za-z0-9_\\-]{1,59}" - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "resourceId":{ - "shape":"String", - "documentation":"The resource ID of the resource not found.
" - }, - "resourceType":{ - "shape":"String", - "documentation":"The resource type of the resource not found.
" - } - }, - "documentation":"The specified resource was not found.
", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResourceType":{ - "type":"structure", - "members":{ - "cloudFormation":{ - "shape":"CloudFormation", - "documentation":"The CloudFormation template of the resource type.
" - }, - "m2ManagedApplication":{ - "shape":"M2ManagedApplication", - "documentation":"The AWS Mainframe Modernization managed application of the resource type.
" - }, - "m2NonManagedApplication":{ - "shape":"M2NonManagedApplication", - "documentation":"The AWS Mainframe Modernization non-managed application of the resource type.
" - } - }, - "documentation":"Specifies the resource type.
", - "union":true - }, - "S3Uri":{ - "type":"string", - "max":1024, - "min":0 - }, - "Script":{ - "type":"structure", - "required":[ - "scriptLocation", - "type" - ], - "members":{ - "scriptLocation":{ - "shape":"S3Uri", - "documentation":"The script location of the scripts.
" - }, - "type":{ - "shape":"ScriptType", - "documentation":"The type of the scripts.
" - } - }, - "documentation":"Specifies the script.
" - }, - "ScriptSummary":{ - "type":"structure", - "required":[ - "scriptLocation", - "type" - ], - "members":{ - "scriptLocation":{ - "shape":"S3Uri", - "documentation":"The script location of the script summary.
" - }, - "type":{ - "shape":"ScriptType", - "documentation":"The type of the script summary.
" - } - }, - "documentation":"Specifies the scripts summary.
" - }, - "ScriptType":{ - "type":"string", - "enum":["Selenium"] - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "resourceId":{ - "shape":"String", - "documentation":"The resource ID of AWS Application Testing that exceeded the limit.
" - }, - "resourceType":{ - "shape":"String", - "documentation":"The resource type of AWS Application Testing that exceeded the limit.
" - }, - "serviceCode":{ - "shape":"String", - "documentation":"The service code of AWS Application Testing that exceeded the limit.
" - }, - "quotaCode":{ - "shape":"String", - "documentation":"The quote codes of AWS Application Testing that exceeded the limit.
" - } - }, - "documentation":"One or more quotas for AWS Application Testing exceeds the limit.
", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "ServiceSettings":{ - "type":"structure", - "members":{ - "kmsKeyId":{ - "shape":"String", - "documentation":"The KMS key ID of the service settings.
" - } - }, - "documentation":"Specifies the service settings.
" - }, - "SourceDatabase":{ - "type":"string", - "enum":["z/OS-DB2"] - }, - "SourceDatabaseMetadata":{ - "type":"structure", - "required":[ - "type", - "captureTool" - ], - "members":{ - "type":{ - "shape":"SourceDatabase", - "documentation":"The type of the source database metadata.
" - }, - "captureTool":{ - "shape":"CaptureTool", - "documentation":"The capture tool of the source database metadata.
" - } - }, - "documentation":"Specifies the source database metadata.
" - }, - "StartTestRunRequest":{ - "type":"structure", - "required":["testSuiteId"], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test run.
" - }, - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The configuration ID of the test run.
" - }, - "clientToken":{ - "shape":"IdempotencyTokenString", - "documentation":"The client token of the test run.
", - "idempotencyToken":true - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the test run.
" - } - } - }, - "StartTestRunResponse":{ - "type":"structure", - "required":[ - "testRunId", - "testRunStatus" - ], - "members":{ - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run ID of the test run.
" - }, - "testRunStatus":{ - "shape":"TestRunStatus", - "documentation":"The test run status of the test run.
" - } - } - }, - "Step":{ - "type":"structure", - "required":[ - "name", - "action" - ], - "members":{ - "name":{ - "shape":"ResourceName", - "documentation":"The name of the step.
" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the step.
" - }, - "action":{ - "shape":"StepAction", - "documentation":"The action of the step.
" - } - }, - "documentation":"Defines a step.
" - }, - "StepAction":{ - "type":"structure", - "members":{ - "resourceAction":{ - "shape":"ResourceAction", - "documentation":"The resource action of the step action.
" - }, - "mainframeAction":{ - "shape":"MainframeAction", - "documentation":"The mainframe action of the step action.
" - }, - "compareAction":{ - "shape":"CompareAction", - "documentation":"The compare action of the step action.
" - } - }, - "documentation":"Specifies a step action.
", - "union":true - }, - "StepList":{ - "type":"list", - "member":{"shape":"Step"}, - "max":20, - "min":1 - }, - "StepRunStatus":{ - "type":"string", - "enum":[ - "Success", - "Failed", - "Running" - ] - }, - "StepRunSummary":{ - "type":"structure", - "members":{ - "mainframeAction":{ - "shape":"MainframeActionSummary", - "documentation":"The mainframe action of the step run summary.
" - }, - "compareAction":{ - "shape":"CompareActionSummary", - "documentation":"The compare action of the step run summary.
" - }, - "resourceAction":{ - "shape":"ResourceActionSummary", - "documentation":"The resource action of the step run summary.
" - } - }, - "documentation":"Defines the step run summary.
", - "union":true - }, - "String":{"type":"string"}, - "String100":{ - "type":"string", - "pattern":"\\S{1,100}" - }, - "String50":{ - "type":"string", - "pattern":"\\S{1,50}" - }, - "TN3270":{ - "type":"structure", - "required":["script"], - "members":{ - "script":{ - "shape":"Script", - "documentation":"The script of the TN3270 protocol.
" - }, - "exportDataSetNames":{ - "shape":"ExportDataSetNames", - "documentation":"The data set names of the TN3270 protocol.
" - } - }, - "documentation":"Specifies the TN3270 protocol.
" - }, - "TN3270StepInput":{ - "type":"structure", - "required":[ - "resource", - "script" - ], - "members":{ - "resource":{ - "shape":"MainframeResourceSummary", - "documentation":"The resource of the TN3270 step input.
" - }, - "script":{ - "shape":"ScriptSummary", - "documentation":"The script of the TN3270 step input.
" - }, - "exportDataSetNames":{ - "shape":"ExportDataSetNames", - "documentation":"The export data set names of the TN3270 step input.
" - }, - "properties":{ - "shape":"MainframeActionProperties", - "documentation":"The properties of the TN3270 step input.
" - } - }, - "documentation":"Specifies a TN3270 step input.
" - }, - "TN3270StepOutput":{ - "type":"structure", - "required":["scriptOutputLocation"], - "members":{ - "dataSetExportLocation":{ - "shape":"S3Uri", - "documentation":"The data set export location of the TN3270 step output.
" - }, - "dmsOutputLocation":{ - "shape":"S3Uri", - "documentation":"The output location of the TN3270 step output.
" - }, - "dataSetDetails":{ - "shape":"DataSetList", - "documentation":"The data set details of the TN3270 step output.
" - }, - "scriptOutputLocation":{ - "shape":"S3Uri", - "documentation":"The script output location of the TN3270 step output.
" - } - }, - "documentation":"Specifies a TN3270 step output.
" - }, - "TN3270Summary":{ - "type":"structure", - "required":["stepInput"], - "members":{ - "stepInput":{ - "shape":"TN3270StepInput", - "documentation":"The step input of the TN3270 summary.
" - }, - "stepOutput":{ - "shape":"TN3270StepOutput", - "documentation":"The step output of the TN3270 summary.
" - } - }, - "documentation":"Specifies a TN3270 summary.
" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"(?!aws:).+" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":200, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the tag resource.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of the resource.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0 - }, - "TargetDatabase":{ - "type":"string", - "enum":["PostgreSQL"] - }, - "TargetDatabaseMetadata":{ - "type":"structure", - "required":[ - "type", - "captureTool" - ], - "members":{ - "type":{ - "shape":"TargetDatabase", - "documentation":"The type of the target database metadata.
" - }, - "captureTool":{ - "shape":"CaptureTool", - "documentation":"The capture tool of the target database metadata.
" - } - }, - "documentation":"Specifies a target database metadata.
" - }, - "TestCaseIdList":{ - "type":"list", - "member":{"shape":"Identifier"} - }, - "TestCaseLatestVersion":{ - "type":"structure", - "required":[ - "version", - "status" - ], - "members":{ - "version":{ - "shape":"Version", - "documentation":"The version of the test case latest version.
" - }, - "status":{ - "shape":"TestCaseLifecycle", - "documentation":"The status of the test case latest version.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test case latest version.
" - } - }, - "documentation":"Specifies the latest version of a test case.
" - }, - "TestCaseLifecycle":{ - "type":"string", - "enum":[ - "Active", - "Deleting" - ] - }, - "TestCaseList":{ - "type":"list", - "member":{"shape":"Identifier"} - }, - "TestCaseRunStatus":{ - "type":"string", - "enum":[ - "Success", - "Running", - "Failed" - ] - }, - "TestCaseRunSummary":{ - "type":"structure", - "required":[ - "testCaseId", - "testCaseVersion", - "testRunId", - "status", - "runStartTime" - ], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case id of the test case run summary.
" - }, - "testCaseVersion":{ - "shape":"Version", - "documentation":"The test case version of the test case run summary.
" - }, - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run id of the test case run summary.
" - }, - "status":{ - "shape":"TestCaseRunStatus", - "documentation":"The status of the test case run summary.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test case run summary.
" - }, - "runStartTime":{ - "shape":"Timestamp", - "documentation":"The run start time of the test case run summary.
" - }, - "runEndTime":{ - "shape":"Timestamp", - "documentation":"The run end time of the test case run summary.
" - } - }, - "documentation":"Specifies the test case run summary.
" - }, - "TestCaseRunSummaryList":{ - "type":"list", - "member":{"shape":"TestCaseRunSummary"} - }, - "TestCaseSummary":{ - "type":"structure", - "required":[ - "testCaseId", - "testCaseArn", - "name", - "latestVersion", - "status", - "creationTime", - "lastUpdateTime" - ], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test case summary.
" - }, - "testCaseArn":{ - "shape":"Arn", - "documentation":"The test case Amazon Resource Name (ARN) of the test case summary.
" - }, - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test case summary.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test case summary.
" - }, - "latestVersion":{ - "shape":"Version", - "documentation":"The latest version of the test case summary.
" - }, - "status":{ - "shape":"TestCaseLifecycle", - "documentation":"The status of the test case summary.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The creation time of the test case summary.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last update time of the test case summary.
" - } - }, - "documentation":"Specifies a test case summary.
" - }, - "TestCaseSummaryList":{ - "type":"list", - "member":{"shape":"TestCaseSummary"} - }, - "TestCases":{ - "type":"structure", - "members":{ - "sequential":{ - "shape":"TestCaseList", - "documentation":"The sequential of the test case.
" - } - }, - "documentation":"Specifies test cases.
", - "union":true - }, - "TestConfigurationIdList":{ - "type":"list", - "member":{"shape":"Identifier"} - }, - "TestConfigurationLatestVersion":{ - "type":"structure", - "required":[ - "version", - "status" - ], - "members":{ - "version":{ - "shape":"Version", - "documentation":"The version of the test configuration latest version.
" - }, - "status":{ - "shape":"TestConfigurationLifecycle", - "documentation":"The status of the test configuration latest version.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test configuration latest version.
" - } - }, - "documentation":"Specifies the latest version of the test configuration.
" - }, - "TestConfigurationLifecycle":{ - "type":"string", - "enum":[ - "Active", - "Deleting" - ] - }, - "TestConfigurationList":{ - "type":"list", - "member":{"shape":"TestConfigurationSummary"} - }, - "TestConfigurationSummary":{ - "type":"structure", - "required":[ - "testConfigurationId", - "name", - "latestVersion", - "testConfigurationArn", - "status", - "creationTime", - "lastUpdateTime" - ], - "members":{ - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The test configuration ID of the test configuration summary.
" - }, - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test configuration summary.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test configuration summary.
" - }, - "latestVersion":{ - "shape":"Version", - "documentation":"The latest version of the test configuration summary.
" - }, - "testConfigurationArn":{ - "shape":"Arn", - "documentation":"The test configuration ARN of the test configuration summary.
" - }, - "status":{ - "shape":"TestConfigurationLifecycle", - "documentation":"The status of the test configuration summary.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The creation time of the test configuration summary.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last update time of the test configuration summary.
" - } - }, - "documentation":"Specifies a test configuration summary.
" - }, - "TestRunIdList":{ - "type":"list", - "member":{"shape":"Identifier"} - }, - "TestRunStatus":{ - "type":"string", - "enum":[ - "Success", - "Running", - "Failed", - "Deleting" - ] - }, - "TestRunStepSummary":{ - "type":"structure", - "required":[ - "stepName", - "testRunId", - "status", - "runStartTime" - ], - "members":{ - "stepName":{ - "shape":"ResourceName", - "documentation":"The step name of the test run step summary.
" - }, - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run ID of the test run step summary.
" - }, - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test run step summary.
" - }, - "testCaseVersion":{ - "shape":"Version", - "documentation":"The test case version of the test run step summary.
" - }, - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test run step summary.
" - }, - "testSuiteVersion":{ - "shape":"Version", - "documentation":"The test suite version of the test run step summary.
" - }, - "beforeStep":{ - "shape":"Boolean", - "documentation":"The before step of the test run step summary.
" - }, - "afterStep":{ - "shape":"Boolean", - "documentation":"The after step of the test run step summary.
" - }, - "status":{ - "shape":"StepRunStatus", - "documentation":"The status of the test run step summary.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test run step summary.
" - }, - "runStartTime":{ - "shape":"Timestamp", - "documentation":"The run start time of the test run step summary.
" - }, - "runEndTime":{ - "shape":"Timestamp", - "documentation":"The run end time of the test run step summary.
" - } - }, - "documentation":"Specifies a test run step summary.
" - }, - "TestRunStepSummaryList":{ - "type":"list", - "member":{"shape":"TestRunStepSummary"} - }, - "TestRunSummary":{ - "type":"structure", - "required":[ - "testRunId", - "testRunArn", - "testSuiteId", - "testSuiteVersion", - "status", - "runStartTime" - ], - "members":{ - "testRunId":{ - "shape":"Identifier", - "documentation":"The test run ID of the test run summary.
" - }, - "testRunArn":{ - "shape":"Arn", - "documentation":"The test run ARN of the test run summary.
" - }, - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test run summary.
" - }, - "testSuiteVersion":{ - "shape":"Version", - "documentation":"The test suite version of the test run summary.
" - }, - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The test configuration ID of the test run summary.
" - }, - "testConfigurationVersion":{ - "shape":"Version", - "documentation":"The test configuration version of the test run summary.
" - }, - "status":{ - "shape":"TestRunStatus", - "documentation":"The status of the test run summary.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test run summary.
" - }, - "runStartTime":{ - "shape":"Timestamp", - "documentation":"The run start time of the test run summary.
" - }, - "runEndTime":{ - "shape":"Timestamp", - "documentation":"The run end time of the test run summary.
" - } - }, - "documentation":"Specifies a test run summary.
" - }, - "TestRunSummaryList":{ - "type":"list", - "member":{"shape":"TestRunSummary"} - }, - "TestSuiteIdList":{ - "type":"list", - "member":{"shape":"Identifier"} - }, - "TestSuiteLatestVersion":{ - "type":"structure", - "required":[ - "version", - "status" - ], - "members":{ - "version":{ - "shape":"Version", - "documentation":"The version of the test suite latest version.
" - }, - "status":{ - "shape":"TestSuiteLifecycle", - "documentation":"The status of the test suite latest version.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test suite latest version.
" - } - }, - "documentation":"Specifies the latest version of a test suite.
" - }, - "TestSuiteLifecycle":{ - "type":"string", - "enum":[ - "Creating", - "Updating", - "Active", - "Failed", - "Deleting" - ] - }, - "TestSuiteList":{ - "type":"list", - "member":{"shape":"TestSuiteSummary"} - }, - "TestSuiteSummary":{ - "type":"structure", - "required":[ - "testSuiteId", - "name", - "latestVersion", - "testSuiteArn", - "status", - "creationTime", - "lastUpdateTime" - ], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test suite summary.
" - }, - "name":{ - "shape":"ResourceName", - "documentation":"The name of the test suite summary.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the test suite summary.
" - }, - "latestVersion":{ - "shape":"Version", - "documentation":"The latest version of the test suite summary.
" - }, - "testSuiteArn":{ - "shape":"Arn", - "documentation":"The test suite Amazon Resource Name (ARN) of the test suite summary.
" - }, - "status":{ - "shape":"TestSuiteLifecycle", - "documentation":"The status of the test suite summary.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The creation time of the test suite summary.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last update time of the test suite summary.
" - } - }, - "documentation":"Specifies the test suite summary.
" - }, - "ThrottlingException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "serviceCode":{ - "shape":"String", - "documentation":"The service code of requests that exceed the limit.
" - }, - "quotaCode":{ - "shape":"String", - "documentation":"The quota code of requests that exceed the limit.
" - }, - "retryAfterSeconds":{ - "shape":"Integer", - "documentation":"The number of seconds to retry after for requests that exceed the limit.
", - "location":"header", - "locationName":"Retry-After" - } - }, - "documentation":"The number of requests made exceeds the limit.
", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "retryable":{"throttling":true} - }, - "Timestamp":{"type":"timestamp"}, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the resource.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "documentation":"The tag keys of the resource.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateTestCaseRequest":{ - "type":"structure", - "required":["testCaseId"], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test case.
", - "location":"uri", - "locationName":"testCaseId" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test case.
" - }, - "steps":{ - "shape":"StepList", - "documentation":"The steps of the test case.
" - } - } - }, - "UpdateTestCaseResponse":{ - "type":"structure", - "required":[ - "testCaseId", - "testCaseVersion" - ], - "members":{ - "testCaseId":{ - "shape":"Identifier", - "documentation":"The test case ID of the test case.
" - }, - "testCaseVersion":{ - "shape":"Version", - "documentation":"The test case version of the test case.
" - } - } - }, - "UpdateTestConfigurationRequest":{ - "type":"structure", - "required":["testConfigurationId"], - "members":{ - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The test configuration ID of the test configuration.
", - "location":"uri", - "locationName":"testConfigurationId" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test configuration.
" - }, - "resources":{ - "shape":"ResourceList", - "documentation":"The resources of the test configuration.
" - }, - "properties":{ - "shape":"Properties", - "documentation":"The properties of the test configuration.
" - }, - "serviceSettings":{ - "shape":"ServiceSettings", - "documentation":"The service settings of the test configuration.
" - } - } - }, - "UpdateTestConfigurationResponse":{ - "type":"structure", - "required":[ - "testConfigurationId", - "testConfigurationVersion" - ], - "members":{ - "testConfigurationId":{ - "shape":"Identifier", - "documentation":"The configuration ID of the test configuration.
" - }, - "testConfigurationVersion":{ - "shape":"Version", - "documentation":"The configuration version of the test configuration.
" - } - } - }, - "UpdateTestSuiteRequest":{ - "type":"structure", - "required":["testSuiteId"], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test suite.
", - "location":"uri", - "locationName":"testSuiteId" - }, - "description":{ - "shape":"ResourceDescription", - "documentation":"The description of the test suite.
" - }, - "beforeSteps":{ - "shape":"StepList", - "documentation":"The before steps for the test suite.
" - }, - "afterSteps":{ - "shape":"StepList", - "documentation":"The after steps of the test suite.
" - }, - "testCases":{ - "shape":"TestCases", - "documentation":"The test cases in the test suite.
" - } - } - }, - "UpdateTestSuiteResponse":{ - "type":"structure", - "required":["testSuiteId"], - "members":{ - "testSuiteId":{ - "shape":"Identifier", - "documentation":"The test suite ID of the test suite.
" - }, - "testSuiteVersion":{ - "shape":"Version", - "documentation":"The test suite version of the test suite.
" - } - } - }, - "ValidationException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"}, - "reason":{ - "shape":"ValidationExceptionReason", - "documentation":"The reason for the validation exception.
" - }, - "fieldList":{ - "shape":"ValidationExceptionFieldList", - "documentation":"The field list of the validation exception.
" - } - }, - "documentation":"One or more parameter provided in the request is not valid.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "name", - "message" - ], - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of the validation exception field.
" - }, - "message":{ - "shape":"String", - "documentation":"The message stating reason for why service validation failed.
" - } - }, - "documentation":"Specifies a validation exception field.
" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "unknownOperation", - "cannotParse", - "fieldValidationFailed", - "other" - ] - }, - "Variable":{ - "type":"string", - "pattern":"\\S{1,1000}" - }, - "Version":{ - "type":"integer", - "box":true - } - }, - "documentation":"AWS Mainframe Modernization Application Testing provides tools and resources for automated functional equivalence testing for your migration projects.
" -} diff --git a/awscli/botocore/data/apptest/2022-12-06/waiters-2.json b/awscli/botocore/data/apptest/2022-12-06/waiters-2.json deleted file mode 100644 index 13f60ee66be6..000000000000 --- a/awscli/botocore/data/apptest/2022-12-06/waiters-2.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "version": 2, - "waiters": { - } -} diff --git a/awscli/botocore/data/endpoints.json b/awscli/botocore/data/endpoints.json index 0b6a9aad7985..e63adb9d46c6 100644 --- a/awscli/botocore/data/endpoints.json +++ b/awscli/botocore/data/endpoints.json @@ -1448,71 +1448,6 @@ } } }, - "api.fleethub.iot" : { - "endpoints" : { - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { - "variants" : [ { - "hostname" : "api.fleethub.iot-fips.ca-central-1.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "fips-ca-central-1" : { - "credentialScope" : { - "region" : "ca-central-1" - }, - "deprecated" : true, - "hostname" : "api.fleethub.iot-fips.ca-central-1.amazonaws.com" - }, - "fips-us-east-1" : { - "credentialScope" : { - "region" : "us-east-1" - }, - "deprecated" : true, - "hostname" : "api.fleethub.iot-fips.us-east-1.amazonaws.com" - }, - "fips-us-east-2" : { - "credentialScope" : { - "region" : "us-east-2" - }, - "deprecated" : true, - "hostname" : "api.fleethub.iot-fips.us-east-2.amazonaws.com" - }, - "fips-us-west-2" : { - "credentialScope" : { - "region" : "us-west-2" - }, - "deprecated" : true, - "hostname" : "api.fleethub.iot-fips.us-west-2.amazonaws.com" - }, - "us-east-1" : { - "variants" : [ { - "hostname" : "api.fleethub.iot-fips.us-east-1.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "us-east-2" : { - "variants" : [ { - "hostname" : "api.fleethub.iot-fips.us-east-2.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "us-west-2" : { - "variants" : [ { - "hostname" : "api.fleethub.iot-fips.us-west-2.amazonaws.com", - "tags" : [ "fips" ] - } ] - } - } - }, "api.iotdeviceadvisor" : { "endpoints" : { "ap-northeast-1" : { @@ -3002,21 +2937,6 @@ } } }, - "apptest" : { - "endpoints" : { - "ap-southeast-2" : { }, - "eu-central-1" : { }, - "fips-us-east-1" : { - "deprecated" : true - }, - "sa-east-1" : { }, - "us-east-1" : { - "variants" : [ { - "tags" : [ "fips" ] - } ] - } - } - }, "aps" : { "defaults" : { "protocols" : [ "https" ] @@ -15942,30 +15862,6 @@ "us-east-1" : { } } }, - "lookoutmetrics" : { - "endpoints" : { - "ap-northeast-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-west-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } - } - }, - "lookoutvision" : { - "endpoints" : { - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "eu-central-1" : { }, - "eu-west-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } - } - }, "m2" : { "endpoints" : { "af-south-1" : { }, @@ -19269,69 +19165,6 @@ } } }, - "qldb" : { - "endpoints" : { - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { - "variants" : [ { - "hostname" : "qldb-fips.ca-central-1.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "eu-central-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "fips-ca-central-1" : { - "credentialScope" : { - "region" : "ca-central-1" - }, - "deprecated" : true, - "hostname" : "qldb-fips.ca-central-1.amazonaws.com" - }, - "fips-us-east-1" : { - "credentialScope" : { - "region" : "us-east-1" - }, - "deprecated" : true, - "hostname" : "qldb-fips.us-east-1.amazonaws.com" - }, - "fips-us-east-2" : { - "credentialScope" : { - "region" : "us-east-2" - }, - "deprecated" : true, - "hostname" : "qldb-fips.us-east-2.amazonaws.com" - }, - "fips-us-west-2" : { - "credentialScope" : { - "region" : "us-west-2" - }, - "deprecated" : true, - "hostname" : "qldb-fips.us-west-2.amazonaws.com" - }, - "us-east-1" : { - "variants" : [ { - "hostname" : "qldb-fips.us-east-1.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "us-east-2" : { - "variants" : [ { - "hostname" : "qldb-fips.us-east-2.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "us-west-2" : { - "variants" : [ { - "hostname" : "qldb-fips.us-west-2.amazonaws.com", - "tags" : [ "fips" ] - } ] - } - } - }, "query.timestream" : { "endpoints" : { "ap-northeast-1" : { }, @@ -20944,17 +20777,6 @@ } } }, - "robomaker" : { - "endpoints" : { - "ap-northeast-1" : { }, - "ap-southeast-1" : { }, - "eu-central-1" : { }, - "eu-west-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } - } - }, "rolesanywhere" : { "endpoints" : { "af-south-1" : { }, @@ -27940,46 +27762,6 @@ "us-west-2" : { } } }, - "waf" : { - "endpoints" : { - "aws" : { - "credentialScope" : { - "region" : "us-east-1" - }, - "deprecated" : true, - "variants" : [ { - "hostname" : "waf-fips.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "aws-fips" : { - "credentialScope" : { - "region" : "us-east-1" - }, - "deprecated" : true, - "hostname" : "waf-fips.amazonaws.com" - }, - "aws-global" : { - "credentialScope" : { - "region" : "us-east-1" - }, - "hostname" : "waf.amazonaws.com", - "variants" : [ { - "hostname" : "waf-fips.amazonaws.com", - "tags" : [ "fips" ] - } ] - }, - "aws-global-fips" : { - "credentialScope" : { - "region" : "us-east-1" - }, - "deprecated" : true, - "hostname" : "waf-fips.amazonaws.com" - } - }, - "isRegionalized" : false, - "partitionEndpoint" : "aws-global" - }, "waf-regional" : { "endpoints" : { "af-south-1" : { @@ -35215,11 +34997,6 @@ } } }, - "robomaker" : { - "endpoints" : { - "us-gov-west-1" : { } - } - }, "rolesanywhere" : { "endpoints" : { "fips-us-gov-east-1" : { diff --git a/awscli/botocore/data/iotfleethub/2020-11-03/endpoint-rule-set-1.json b/awscli/botocore/data/iotfleethub/2020-11-03/endpoint-rule-set-1.json deleted file mode 100644 index bd6d7696a909..000000000000 --- a/awscli/botocore/data/iotfleethub/2020-11-03/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/iotfleethub/2020-11-03/paginators-1.json b/awscli/botocore/data/iotfleethub/2020-11-03/paginators-1.json deleted file mode 100644 index 74c96f517796..000000000000 --- a/awscli/botocore/data/iotfleethub/2020-11-03/paginators-1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "pagination": { - "ListApplications": { - "input_token": "nextToken", - "output_token": "nextToken", - "result_key": "applicationSummaries" - } - } -} diff --git a/awscli/botocore/data/iotfleethub/2020-11-03/service-2.json b/awscli/botocore/data/iotfleethub/2020-11-03/service-2.json deleted file mode 100644 index d3b3ef51cf0f..000000000000 --- a/awscli/botocore/data/iotfleethub/2020-11-03/service-2.json +++ /dev/null @@ -1,595 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2020-11-03", - "endpointPrefix":"api.fleethub.iot", - "jsonVersion":"1.1", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"AWS IoT Fleet Hub", - "serviceId":"IoTFleetHub", - "signatureVersion":"v4", - "signingName":"iotfleethub", - "uid":"iotfleethub-2020-11-03", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "CreateApplication":{ - "name":"CreateApplication", - "http":{ - "method":"POST", - "requestUri":"/applications", - "responseCode":201 - }, - "input":{"shape":"CreateApplicationRequest"}, - "output":{"shape":"CreateApplicationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalFailureException"}, - {"shape":"ThrottlingException"}, - {"shape":"LimitExceededException"} - ], - "documentation":"Creates a Fleet Hub for IoT Device Management web application.
When creating a Fleet Hub application, you must create an organization instance of IAM Identity Center if you don't already have one. The Fleet Hub application you create must also be in the same Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see Enabling IAM Identity Center and Organization instances of IAM Identity Center.
" - }, - "DeleteApplication":{ - "name":"DeleteApplication", - "http":{ - "method":"DELETE", - "requestUri":"/applications/{applicationId}", - "responseCode":204 - }, - "input":{"shape":"DeleteApplicationRequest"}, - "output":{"shape":"DeleteApplicationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalFailureException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Deletes a Fleet Hub for IoT Device Management web application.
" - }, - "DescribeApplication":{ - "name":"DescribeApplication", - "http":{ - "method":"GET", - "requestUri":"/applications/{applicationId}", - "responseCode":200 - }, - "input":{"shape":"DescribeApplicationRequest"}, - "output":{"shape":"DescribeApplicationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalFailureException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Gets information about a Fleet Hub for IoT Device Management web application.
" - }, - "ListApplications":{ - "name":"ListApplications", - "http":{ - "method":"GET", - "requestUri":"/applications", - "responseCode":200 - }, - "input":{"shape":"ListApplicationsRequest"}, - "output":{"shape":"ListApplicationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalFailureException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Gets a list of Fleet Hub for IoT Device Management web applications for the current account.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"InternalFailureException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Lists the tags for the specified resource.
" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"InternalFailureException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"InternalFailureException"}, - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Removes the specified tags (metadata) from the resource.
" - }, - "UpdateApplication":{ - "name":"UpdateApplication", - "http":{ - "method":"PATCH", - "requestUri":"/applications/{applicationId}", - "responseCode":202 - }, - "input":{"shape":"UpdateApplicationRequest"}, - "output":{"shape":"UpdateApplicationResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalFailureException"}, - {"shape":"ConflictException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Updates information about a Fleet Hub for IoT Device Management web application.
" - } - }, - "shapes":{ - "ApplicationState":{ - "type":"string", - "enum":[ - "CREATING", - "DELETING", - "ACTIVE", - "CREATE_FAILED", - "DELETE_FAILED" - ] - }, - "ApplicationSummaries":{ - "type":"list", - "member":{"shape":"ApplicationSummary"} - }, - "ApplicationSummary":{ - "type":"structure", - "required":[ - "applicationId", - "applicationName", - "applicationUrl" - ], - "members":{ - "applicationId":{ - "shape":"Id", - "documentation":"The unique Id of the web application.
" - }, - "applicationName":{ - "shape":"Name", - "documentation":"The name of the web application.
" - }, - "applicationDescription":{ - "shape":"Description", - "documentation":"An optional description of the web application.
" - }, - "applicationUrl":{ - "shape":"Url", - "documentation":"The URL of the web application.
" - }, - "applicationCreationDate":{ - "shape":"Timestamp", - "documentation":"The date (in Unix epoch time) when the web application was created.
" - }, - "applicationLastUpdateDate":{ - "shape":"Timestamp", - "documentation":"The date (in Unix epoch time) when the web application was last updated.
" - }, - "applicationState":{ - "shape":"ApplicationState", - "documentation":"The current state of the web application.
" - } - }, - "documentation":"A summary of information about a Fleet Hub for IoT Device Management web application.
" - }, - "Arn":{ - "type":"string", - "max":1600, - "min":1, - "pattern":"^arn:[!-~]+$" - }, - "ClientRequestToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^[a-zA-Z0-9-_]+$" - }, - "ConflictException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The request conflicts with the current state of the resource.
", - "error":{"httpStatusCode":409}, - "exception":true - }, - "CreateApplicationRequest":{ - "type":"structure", - "required":[ - "applicationName", - "roleArn" - ], - "members":{ - "applicationName":{ - "shape":"Name", - "documentation":"The name of the web application.
" - }, - "applicationDescription":{ - "shape":"Description", - "documentation":"An optional description of the web application.
" - }, - "clientToken":{ - "shape":"ClientRequestToken", - "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", - "idempotencyToken":true - }, - "roleArn":{ - "shape":"Arn", - "documentation":"The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.
The name of the role must be in the form AWSIotFleetHub_random_string
.
A set of key/value pairs that you can use to manage the web application resource.
" - } - } - }, - "CreateApplicationResponse":{ - "type":"structure", - "required":[ - "applicationId", - "applicationArn" - ], - "members":{ - "applicationId":{ - "shape":"Id", - "documentation":"The unique Id of the web application.
" - }, - "applicationArn":{ - "shape":"Arn", - "documentation":"The ARN of the web application.
" - } - } - }, - "DeleteApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"Id", - "documentation":"The unique Id of the web application.
", - "location":"uri", - "locationName":"applicationId" - }, - "clientToken":{ - "shape":"ClientRequestToken", - "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" - } - } - }, - "DeleteApplicationResponse":{ - "type":"structure", - "members":{} - }, - "DescribeApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"Id", - "documentation":"The unique Id of the web application.
", - "location":"uri", - "locationName":"applicationId" - } - } - }, - "DescribeApplicationResponse":{ - "type":"structure", - "required":[ - "applicationId", - "applicationArn", - "applicationName", - "applicationUrl", - "applicationState", - "applicationCreationDate", - "applicationLastUpdateDate", - "roleArn" - ], - "members":{ - "applicationId":{ - "shape":"Id", - "documentation":"The unique Id of the web application.
" - }, - "applicationArn":{ - "shape":"Arn", - "documentation":"The ARN of the web application.
" - }, - "applicationName":{ - "shape":"Name", - "documentation":"The name of the web application.
" - }, - "applicationDescription":{ - "shape":"Description", - "documentation":"An optional description of the web application.
" - }, - "applicationUrl":{ - "shape":"Url", - "documentation":"The URL of the web application.
" - }, - "applicationState":{ - "shape":"ApplicationState", - "documentation":"The current state of the web application.
" - }, - "applicationCreationDate":{ - "shape":"Timestamp", - "documentation":"The date (in Unix epoch time) when the application was created.
" - }, - "applicationLastUpdateDate":{ - "shape":"Timestamp", - "documentation":"The date (in Unix epoch time) when the application was last updated.
" - }, - "roleArn":{ - "shape":"Arn", - "documentation":"The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.
" - }, - "ssoClientId":{ - "shape":"SsoClientId", - "documentation":"The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
" - }, - "errorMessage":{ - "shape":"ErrorMessage", - "documentation":"A message that explains any failures included in the applicationState
response field. This message explains failures in the CreateApplication
and DeleteApplication
actions.
A set of key/value pairs that you can use to manage the web application resource.
" - } - } - }, - "Description":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^[ -~]*$" - }, - "ErrorMessage":{"type":"string"}, - "Id":{ - "type":"string", - "max":36, - "min":36, - "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - }, - "InternalFailureException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"An unexpected error has occurred.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The request is not valid.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"A limit has been exceeded.
", - "error":{"httpStatusCode":410}, - "exception":true - }, - "ListApplicationsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"NextToken", - "documentation":"A token used to get the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListApplicationsResponse":{ - "type":"structure", - "members":{ - "applicationSummaries":{ - "shape":"ApplicationSummaries", - "documentation":"An array of objects that provide summaries of information about the web applications in the list.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"A token used to get the next set of results.
" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"The ARN of the resource.
", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"TagMap", - "documentation":"The list of tags assigned to the resource.
" - } - } - }, - "Name":{ - "type":"string", - "max":100, - "min":1, - "pattern":"^[ -~]*$" - }, - "NextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^[A-Za-z0-9+/=]+$" - }, - "ResourceArn":{"type":"string"}, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The specified resource does not exist.
", - "error":{"httpStatusCode":404}, - "exception":true - }, - "SsoClientId":{"type":"string"}, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":1 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"The ARN of the resource.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The new or modified tags for the resource.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":1 - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The rate exceeds the limit.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "Timestamp":{"type":"long"}, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"ResourceArn", - "documentation":"The ARN of the resource.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "documentation":"A list of the keys of the tags to be removed from the resource.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateApplicationRequest":{ - "type":"structure", - "required":["applicationId"], - "members":{ - "applicationId":{ - "shape":"Id", - "documentation":"The unique Id of the web application.
", - "location":"uri", - "locationName":"applicationId" - }, - "applicationName":{ - "shape":"Name", - "documentation":"The name of the web application.
" - }, - "applicationDescription":{ - "shape":"Description", - "documentation":"An optional description of the web application.
" - }, - "clientToken":{ - "shape":"ClientRequestToken", - "documentation":"A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
", - "idempotencyToken":true - } - } - }, - "UpdateApplicationResponse":{ - "type":"structure", - "members":{} - }, - "Url":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^https\\://\\S+$" - }, - "errorMessage":{"type":"string"} - }, - "documentation":"With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.
" -} diff --git a/awscli/botocore/data/lookoutmetrics/2017-07-25/endpoint-rule-set-1.json b/awscli/botocore/data/lookoutmetrics/2017-07-25/endpoint-rule-set-1.json deleted file mode 100644 index a8cbb5728ea7..000000000000 --- a/awscli/botocore/data/lookoutmetrics/2017-07-25/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/lookoutmetrics/2017-07-25/paginators-1.json b/awscli/botocore/data/lookoutmetrics/2017-07-25/paginators-1.json deleted file mode 100644 index ea142457a6a7..000000000000 --- a/awscli/botocore/data/lookoutmetrics/2017-07-25/paginators-1.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "pagination": {} -} diff --git a/awscli/botocore/data/lookoutmetrics/2017-07-25/service-2.json b/awscli/botocore/data/lookoutmetrics/2017-07-25/service-2.json deleted file mode 100644 index a621c1c3fec2..000000000000 --- a/awscli/botocore/data/lookoutmetrics/2017-07-25/service-2.json +++ /dev/null @@ -1,3355 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2017-07-25", - "endpointPrefix":"lookoutmetrics", - "jsonVersion":"1.1", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceAbbreviation":"LookoutMetrics", - "serviceFullName":"Amazon Lookout for Metrics", - "serviceId":"LookoutMetrics", - "signatureVersion":"v4", - "signingName":"lookoutmetrics", - "uid":"lookoutmetrics-2017-07-25", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "ActivateAnomalyDetector":{ - "name":"ActivateAnomalyDetector", - "http":{ - "method":"POST", - "requestUri":"/ActivateAnomalyDetector" - }, - "input":{"shape":"ActivateAnomalyDetectorRequest"}, - "output":{"shape":"ActivateAnomalyDetectorResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"} - ], - "documentation":"Activates an anomaly detector.
" - }, - "BackTestAnomalyDetector":{ - "name":"BackTestAnomalyDetector", - "http":{ - "method":"POST", - "requestUri":"/BackTestAnomalyDetector" - }, - "input":{"shape":"BackTestAnomalyDetectorRequest"}, - "output":{"shape":"BackTestAnomalyDetectorResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Runs a backtest for anomaly detection for the specified resource.
" - }, - "CreateAlert":{ - "name":"CreateAlert", - "http":{ - "method":"POST", - "requestUri":"/CreateAlert" - }, - "input":{"shape":"CreateAlertRequest"}, - "output":{"shape":"CreateAlertResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates an alert for an anomaly detector.
" - }, - "CreateAnomalyDetector":{ - "name":"CreateAnomalyDetector", - "http":{ - "method":"POST", - "requestUri":"/CreateAnomalyDetector" - }, - "input":{"shape":"CreateAnomalyDetectorRequest"}, - "output":{"shape":"CreateAnomalyDetectorResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates an anomaly detector.
" - }, - "CreateMetricSet":{ - "name":"CreateMetricSet", - "http":{ - "method":"POST", - "requestUri":"/CreateMetricSet" - }, - "input":{"shape":"CreateMetricSetRequest"}, - "output":{"shape":"CreateMetricSetResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a dataset.
" - }, - "DeactivateAnomalyDetector":{ - "name":"DeactivateAnomalyDetector", - "http":{ - "method":"POST", - "requestUri":"/DeactivateAnomalyDetector" - }, - "input":{"shape":"DeactivateAnomalyDetectorRequest"}, - "output":{"shape":"DeactivateAnomalyDetectorResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deactivates an anomaly detector.
" - }, - "DeleteAlert":{ - "name":"DeleteAlert", - "http":{ - "method":"POST", - "requestUri":"/DeleteAlert" - }, - "input":{"shape":"DeleteAlertRequest"}, - "output":{"shape":"DeleteAlertResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes an alert.
" - }, - "DeleteAnomalyDetector":{ - "name":"DeleteAnomalyDetector", - "http":{ - "method":"POST", - "requestUri":"/DeleteAnomalyDetector" - }, - "input":{"shape":"DeleteAnomalyDetectorRequest"}, - "output":{"shape":"DeleteAnomalyDetectorResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
" - }, - "DescribeAlert":{ - "name":"DescribeAlert", - "http":{ - "method":"POST", - "requestUri":"/DescribeAlert" - }, - "input":{"shape":"DescribeAlertRequest"}, - "output":{"shape":"DescribeAlertResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Describes an alert.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
" - }, - "DescribeAnomalyDetectionExecutions":{ - "name":"DescribeAnomalyDetectionExecutions", - "http":{ - "method":"POST", - "requestUri":"/DescribeAnomalyDetectionExecutions" - }, - "input":{"shape":"DescribeAnomalyDetectionExecutionsRequest"}, - "output":{"shape":"DescribeAnomalyDetectionExecutionsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about the status of the specified anomaly detection jobs.
" - }, - "DescribeAnomalyDetector":{ - "name":"DescribeAnomalyDetector", - "http":{ - "method":"POST", - "requestUri":"/DescribeAnomalyDetector" - }, - "input":{"shape":"DescribeAnomalyDetectorRequest"}, - "output":{"shape":"DescribeAnomalyDetectorResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Describes a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
" - }, - "DescribeMetricSet":{ - "name":"DescribeMetricSet", - "http":{ - "method":"POST", - "requestUri":"/DescribeMetricSet" - }, - "input":{"shape":"DescribeMetricSetRequest"}, - "output":{"shape":"DescribeMetricSetResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Describes a dataset.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
" - }, - "DetectMetricSetConfig":{ - "name":"DetectMetricSetConfig", - "http":{ - "method":"POST", - "requestUri":"/DetectMetricSetConfig" - }, - "input":{"shape":"DetectMetricSetConfigRequest"}, - "output":{"shape":"DetectMetricSetConfigResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Detects an Amazon S3 dataset's file format, interval, and offset.
" - }, - "GetAnomalyGroup":{ - "name":"GetAnomalyGroup", - "http":{ - "method":"POST", - "requestUri":"/GetAnomalyGroup" - }, - "input":{"shape":"GetAnomalyGroupRequest"}, - "output":{"shape":"GetAnomalyGroupResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Returns details about a group of anomalous metrics.
" - }, - "GetDataQualityMetrics":{ - "name":"GetDataQualityMetrics", - "http":{ - "method":"POST", - "requestUri":"/GetDataQualityMetrics" - }, - "input":{"shape":"GetDataQualityMetricsRequest"}, - "output":{"shape":"GetDataQualityMetricsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns details about the requested data quality metrics.
" - }, - "GetFeedback":{ - "name":"GetFeedback", - "http":{ - "method":"POST", - "requestUri":"/GetFeedback" - }, - "input":{"shape":"GetFeedbackRequest"}, - "output":{"shape":"GetFeedbackResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Get feedback for an anomaly group.
" - }, - "GetSampleData":{ - "name":"GetSampleData", - "http":{ - "method":"POST", - "requestUri":"/GetSampleData" - }, - "input":{"shape":"GetSampleDataRequest"}, - "output":{"shape":"GetSampleDataResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a selection of sample records from an Amazon S3 datasource.
" - }, - "ListAlerts":{ - "name":"ListAlerts", - "http":{ - "method":"POST", - "requestUri":"/ListAlerts" - }, - "input":{"shape":"ListAlertsRequest"}, - "output":{"shape":"ListAlertsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ValidationException"} - ], - "documentation":"Lists the alerts attached to a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
" - }, - "ListAnomalyDetectors":{ - "name":"ListAnomalyDetectors", - "http":{ - "method":"POST", - "requestUri":"/ListAnomalyDetectors" - }, - "input":{"shape":"ListAnomalyDetectorsRequest"}, - "output":{"shape":"ListAnomalyDetectorsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists the detectors in the current AWS Region.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
" - }, - "ListAnomalyGroupRelatedMetrics":{ - "name":"ListAnomalyGroupRelatedMetrics", - "http":{ - "method":"POST", - "requestUri":"/ListAnomalyGroupRelatedMetrics" - }, - "input":{"shape":"ListAnomalyGroupRelatedMetricsRequest"}, - "output":{"shape":"ListAnomalyGroupRelatedMetricsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Returns a list of measures that are potential causes or effects of an anomaly group.
" - }, - "ListAnomalyGroupSummaries":{ - "name":"ListAnomalyGroupSummaries", - "http":{ - "method":"POST", - "requestUri":"/ListAnomalyGroupSummaries" - }, - "input":{"shape":"ListAnomalyGroupSummariesRequest"}, - "output":{"shape":"ListAnomalyGroupSummariesResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Returns a list of anomaly groups.
" - }, - "ListAnomalyGroupTimeSeries":{ - "name":"ListAnomalyGroupTimeSeries", - "http":{ - "method":"POST", - "requestUri":"/ListAnomalyGroupTimeSeries" - }, - "input":{"shape":"ListAnomalyGroupTimeSeriesRequest"}, - "output":{"shape":"ListAnomalyGroupTimeSeriesResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Gets a list of anomalous metrics for a measure in an anomaly group.
" - }, - "ListMetricSets":{ - "name":"ListMetricSets", - "http":{ - "method":"POST", - "requestUri":"/ListMetricSets" - }, - "input":{"shape":"ListMetricSetsRequest"}, - "output":{"shape":"ListMetricSetsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists the datasets in the current AWS Region.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Gets a list of tags for a detector, dataset, or alert.
" - }, - "PutFeedback":{ - "name":"PutFeedback", - "http":{ - "method":"POST", - "requestUri":"/PutFeedback" - }, - "input":{"shape":"PutFeedbackRequest"}, - "output":{"shape":"PutFeedbackResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Add feedback for an anomalous metric.
" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Adds tags to a detector, dataset, or alert.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}", - "responseCode":204 - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Removes tags from a detector, dataset, or alert.
" - }, - "UpdateAlert":{ - "name":"UpdateAlert", - "http":{ - "method":"POST", - "requestUri":"/UpdateAlert" - }, - "input":{"shape":"UpdateAlertRequest"}, - "output":{"shape":"UpdateAlertResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Make changes to an existing alert.
" - }, - "UpdateAnomalyDetector":{ - "name":"UpdateAnomalyDetector", - "http":{ - "method":"POST", - "requestUri":"/UpdateAnomalyDetector" - }, - "input":{"shape":"UpdateAnomalyDetectorRequest"}, - "output":{"shape":"UpdateAnomalyDetectorResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"Updates a detector. After activation, you can only change a detector's ingestion delay and description.
" - }, - "UpdateMetricSet":{ - "name":"UpdateMetricSet", - "http":{ - "method":"POST", - "requestUri":"/UpdateMetricSet" - }, - "input":{"shape":"UpdateMetricSetRequest"}, - "output":{"shape":"UpdateMetricSetResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "documentation":"Updates a dataset.
" - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"Message"} - }, - "documentation":"You do not have sufficient permissions to perform this action.
", - "error":{"httpStatusCode":403}, - "exception":true - }, - "Action":{ - "type":"structure", - "members":{ - "SNSConfiguration":{ - "shape":"SNSConfiguration", - "documentation":"A configuration for an Amazon SNS channel.
" - }, - "LambdaConfiguration":{ - "shape":"LambdaConfiguration", - "documentation":"A configuration for an AWS Lambda channel.
" - } - }, - "documentation":"A configuration that specifies the action to perform when anomalies are detected.
" - }, - "ActivateAnomalyDetectorRequest":{ - "type":"structure", - "required":["AnomalyDetectorArn"], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the anomaly detector.
" - } - } - }, - "ActivateAnomalyDetectorResponse":{ - "type":"structure", - "members":{} - }, - "AggregationFunction":{ - "type":"string", - "enum":[ - "AVG", - "SUM" - ] - }, - "Alert":{ - "type":"structure", - "members":{ - "Action":{ - "shape":"Action", - "documentation":"Action that will be triggered when there is an alert.
" - }, - "AlertDescription":{ - "shape":"AlertDescription", - "documentation":"A description of the alert.
" - }, - "AlertArn":{ - "shape":"Arn", - "documentation":"The ARN of the alert.
" - }, - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector to which the alert is attached.
" - }, - "AlertName":{ - "shape":"AlertName", - "documentation":"The name of the alert.
" - }, - "AlertSensitivityThreshold":{ - "shape":"SensitivityThreshold", - "documentation":"The minimum severity for an anomaly to trigger the alert.
" - }, - "AlertType":{ - "shape":"AlertType", - "documentation":"The type of the alert.
" - }, - "AlertStatus":{ - "shape":"AlertStatus", - "documentation":"The status of the alert.
" - }, - "LastModificationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the alert was last modified.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the alert was created.
" - }, - "AlertFilters":{ - "shape":"AlertFilters", - "documentation":"The configuration of the alert filters, containing MetricList and DimensionFilter.
" - } - }, - "documentation":"A configuration for Amazon SNS-integrated notifications.
" - }, - "AlertDescription":{ - "type":"string", - "max":256, - "pattern":".*\\S.*" - }, - "AlertFilters":{ - "type":"structure", - "members":{ - "MetricList":{ - "shape":"MetricNameList", - "documentation":"The list of measures that you want to get alerts for.
" - }, - "DimensionFilterList":{ - "shape":"DimensionFilterList", - "documentation":"The list of DimensionFilter objects that are used for dimension-based filtering.
" - } - }, - "documentation":"The configuration of the alert filters.
" - }, - "AlertName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" - }, - "AlertStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "INACTIVE" - ] - }, - "AlertSummary":{ - "type":"structure", - "members":{ - "AlertArn":{ - "shape":"Arn", - "documentation":"The ARN of the alert.
" - }, - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector to which the alert is attached.
" - }, - "AlertName":{ - "shape":"AlertName", - "documentation":"The name of the alert.
" - }, - "AlertSensitivityThreshold":{ - "shape":"SensitivityThreshold", - "documentation":"The minimum severity for an anomaly to trigger the alert.
" - }, - "AlertType":{ - "shape":"AlertType", - "documentation":"The type of the alert.
" - }, - "AlertStatus":{ - "shape":"AlertStatus", - "documentation":"The status of the alert.
" - }, - "LastModificationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the alert was last modified.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the alert was created.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The alert's tags.
" - } - }, - "documentation":"Provides a summary of an alert's configuration.
" - }, - "AlertSummaryList":{ - "type":"list", - "member":{"shape":"AlertSummary"} - }, - "AlertType":{ - "type":"string", - "enum":[ - "SNS", - "LAMBDA" - ] - }, - "AnomalyDetectionTaskStatus":{ - "type":"string", - "enum":[ - "PENDING", - "IN_PROGRESS", - "COMPLETED", - "FAILED", - "FAILED_TO_SCHEDULE" - ] - }, - "AnomalyDetectionTaskStatusMessage":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*\\S.*" - }, - "AnomalyDetectorConfig":{ - "type":"structure", - "members":{ - "AnomalyDetectorFrequency":{ - "shape":"Frequency", - "documentation":"The frequency at which the detector analyzes its source data.
" - } - }, - "documentation":"Contains information about a detector's configuration.
" - }, - "AnomalyDetectorConfigSummary":{ - "type":"structure", - "members":{ - "AnomalyDetectorFrequency":{ - "shape":"Frequency", - "documentation":"The interval at which the detector analyzes its source data.
" - } - }, - "documentation":"Contains information about a detector's configuration.
" - }, - "AnomalyDetectorDataQualityMetric":{ - "type":"structure", - "members":{ - "StartTimestamp":{ - "shape":"Timestamp", - "documentation":"The start time for the data quality metrics collection.
" - }, - "MetricSetDataQualityMetricList":{ - "shape":"MetricSetDataQualityMetricList", - "documentation":"An array of DataQualityMetricList
objects. Each object in the array contains information about a data quality metric.
Aggregated details about the data quality metrics collected for the AnomalyDetectorArn
provided in the GetDataQualityMetrics object.
The ARN of the detector.
" - }, - "AnomalyDetectorName":{ - "shape":"AnomalyDetectorName", - "documentation":"The name of the detector.
" - }, - "AnomalyDetectorDescription":{ - "shape":"AnomalyDetectorDescription", - "documentation":"A description of the detector.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the detector was created.
" - }, - "LastModificationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the detector was last modified.
" - }, - "Status":{ - "shape":"AnomalyDetectorStatus", - "documentation":"The status of detector.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The detector's tags.
" - } - }, - "documentation":"Contains information about an an anomaly detector.
" - }, - "AnomalyDetectorSummaryList":{ - "type":"list", - "member":{"shape":"AnomalyDetectorSummary"} - }, - "AnomalyGroup":{ - "type":"structure", - "members":{ - "StartTime":{ - "shape":"TimestampString", - "documentation":"The start time for the group.
" - }, - "EndTime":{ - "shape":"TimestampString", - "documentation":"The end time for the group.
" - }, - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "AnomalyGroupScore":{ - "shape":"Score", - "documentation":"The severity score of the group.
" - }, - "PrimaryMetricName":{ - "shape":"MetricName", - "documentation":"The name of the primary affected measure for the group.
" - }, - "MetricLevelImpactList":{ - "shape":"MetricLevelImpactList", - "documentation":"A list of measures affected by the anomaly.
" - } - }, - "documentation":"A group of anomalous metrics
" - }, - "AnomalyGroupStatistics":{ - "type":"structure", - "members":{ - "EvaluationStartDate":{ - "shape":"TimestampString", - "documentation":"The start of the time range that was searched.
" - }, - "TotalCount":{ - "shape":"Integer", - "documentation":"The number of groups found.
" - }, - "ItemizedMetricStatsList":{ - "shape":"ItemizedMetricStatsList", - "documentation":"Statistics for individual metrics within the group.
" - } - }, - "documentation":"Aggregated statistics for a group of anomalous metrics.
" - }, - "AnomalyGroupSummary":{ - "type":"structure", - "members":{ - "StartTime":{ - "shape":"TimestampString", - "documentation":"The start time for the group.
" - }, - "EndTime":{ - "shape":"TimestampString", - "documentation":"The end time for the group.
" - }, - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "AnomalyGroupScore":{ - "shape":"Score", - "documentation":"The severity score of the group.
" - }, - "PrimaryMetricName":{ - "shape":"MetricName", - "documentation":"The name of the primary affected measure for the group.
" - } - }, - "documentation":"Details about a group of anomalous metrics.
" - }, - "AnomalyGroupSummaryList":{ - "type":"list", - "member":{"shape":"AnomalyGroupSummary"} - }, - "AnomalyGroupTimeSeries":{ - "type":"structure", - "required":["AnomalyGroupId"], - "members":{ - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "TimeSeriesId":{ - "shape":"TimeSeriesId", - "documentation":"The ID of the metric.
" - } - }, - "documentation":"An anomalous metric in an anomaly group.
" - }, - "AnomalyGroupTimeSeriesFeedback":{ - "type":"structure", - "required":[ - "AnomalyGroupId", - "TimeSeriesId", - "IsAnomaly" - ], - "members":{ - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "TimeSeriesId":{ - "shape":"TimeSeriesId", - "documentation":"The ID of the metric.
" - }, - "IsAnomaly":{ - "shape":"Boolean", - "documentation":"Feedback on whether the metric is a legitimate anomaly.
" - } - }, - "documentation":"Feedback for an anomalous metric.
" - }, - "AppFlowConfig":{ - "type":"structure", - "members":{ - "RoleArn":{ - "shape":"Arn", - "documentation":"An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
" - }, - "FlowName":{ - "shape":"FlowName", - "documentation":"name of the flow.
" - } - }, - "documentation":"Details about an Amazon AppFlow flow datasource.
" - }, - "Arn":{ - "type":"string", - "max":256, - "pattern":"arn:([a-z\\d-]+):.*:.*:.*:.+" - }, - "AthenaDataCatalog":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" - }, - "AthenaDatabaseName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[a-zA-Z0-9_]+" - }, - "AthenaS3ResultsPath":{ - "type":"string", - "max":1024, - "pattern":"^s3://[a-z0-9].+$" - }, - "AthenaSourceConfig":{ - "type":"structure", - "members":{ - "RoleArn":{ - "shape":"Arn", - "documentation":"An IAM role that gives Amazon Lookout for Metrics permission to access the data.
" - }, - "DatabaseName":{ - "shape":"AthenaDatabaseName", - "documentation":"The database's name.
" - }, - "DataCatalog":{ - "shape":"AthenaDataCatalog", - "documentation":"The database's data catalog.
" - }, - "TableName":{ - "shape":"AthenaTableName", - "documentation":"The database's table name.
" - }, - "WorkGroupName":{ - "shape":"AthenaWorkGroupName", - "documentation":"The database's work group name.
" - }, - "S3ResultsPath":{ - "shape":"AthenaS3ResultsPath", - "documentation":"The database's results path.
" - }, - "BackTestConfiguration":{ - "shape":"BackTestConfiguration", - "documentation":"Settings for backtest mode.
" - } - }, - "documentation":"Details about an Amazon Athena datasource.
" - }, - "AthenaTableName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9_]+" - }, - "AthenaWorkGroupName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9._-]{1,128}" - }, - "AttributeValue":{ - "type":"structure", - "members":{ - "S":{ - "shape":"StringAttributeValue", - "documentation":"A string.
" - }, - "N":{ - "shape":"NumberAttributeValue", - "documentation":"A number.
" - }, - "B":{ - "shape":"BinaryAttributeValue", - "documentation":"A binary value.
" - }, - "SS":{ - "shape":"StringListAttributeValue", - "documentation":"A list of strings.
" - }, - "NS":{ - "shape":"NumberListAttributeValue", - "documentation":"A list of numbers.
" - }, - "BS":{ - "shape":"BinaryListAttributeValue", - "documentation":"A list of binary values.
" - } - }, - "documentation":"An attribute value.
" - }, - "AutoDetectionMetricSource":{ - "type":"structure", - "members":{ - "S3SourceConfig":{ - "shape":"AutoDetectionS3SourceConfig", - "documentation":"The source's source config.
" - } - }, - "documentation":"An auto detection metric source.
" - }, - "AutoDetectionS3SourceConfig":{ - "type":"structure", - "members":{ - "TemplatedPathList":{ - "shape":"TemplatedPathList", - "documentation":"The config's templated path list.
" - }, - "HistoricalDataPathList":{ - "shape":"HistoricalDataPathList", - "documentation":"The config's historical data path list.
" - } - }, - "documentation":"An auto detection source config.
" - }, - "BackTestAnomalyDetectorRequest":{ - "type":"structure", - "required":["AnomalyDetectorArn"], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector.
" - } - } - }, - "BackTestAnomalyDetectorResponse":{ - "type":"structure", - "members":{} - }, - "BackTestConfiguration":{ - "type":"structure", - "required":["RunBackTestMode"], - "members":{ - "RunBackTestMode":{ - "shape":"Boolean", - "documentation":"Run a backtest instead of monitoring new data.
" - } - }, - "documentation":"Settings for backtest mode.
" - }, - "BinaryAttributeValue":{"type":"string"}, - "BinaryListAttributeValue":{ - "type":"list", - "member":{"shape":"BinaryAttributeValue"} - }, - "Boolean":{"type":"boolean"}, - "CSVFileCompression":{ - "type":"string", - "enum":[ - "NONE", - "GZIP" - ] - }, - "Charset":{ - "type":"string", - "max":63, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" - }, - "CloudWatchConfig":{ - "type":"structure", - "members":{ - "RoleArn":{ - "shape":"Arn", - "documentation":"An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
" - }, - "BackTestConfiguration":{ - "shape":"BackTestConfiguration", - "documentation":"Settings for backtest mode.
" - } - }, - "documentation":"Details about an Amazon CloudWatch datasource.
" - }, - "ColumnName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" - }, - "Confidence":{ - "type":"string", - "enum":[ - "HIGH", - "LOW", - "NONE" - ] - }, - "ConflictException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"Message"}, - "ResourceId":{ - "shape":"ResourceId", - "documentation":"The ID of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of the resource.
" - } - }, - "documentation":"There was a conflict processing the request. Try your request again.
", - "error":{"httpStatusCode":409}, - "exception":true - }, - "ContributionMatrix":{ - "type":"structure", - "members":{ - "DimensionContributionList":{ - "shape":"DimensionContributionList", - "documentation":"A list of contributing dimensions.
" - } - }, - "documentation":"Details about dimensions that contributed to an anomaly.
" - }, - "CreateAlertRequest":{ - "type":"structure", - "required":[ - "AlertName", - "AnomalyDetectorArn", - "Action" - ], - "members":{ - "AlertName":{ - "shape":"AlertName", - "documentation":"The name of the alert.
" - }, - "AlertSensitivityThreshold":{ - "shape":"SensitivityThreshold", - "documentation":"An integer from 0 to 100 specifying the alert sensitivity threshold.
" - }, - "AlertDescription":{ - "shape":"AlertDescription", - "documentation":"A description of the alert.
" - }, - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector to which the alert is attached.
" - }, - "Action":{ - "shape":"Action", - "documentation":"Action that will be triggered when there is an alert.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"A list of tags to apply to the alert.
" - }, - "AlertFilters":{ - "shape":"AlertFilters", - "documentation":"The configuration of the alert filters, containing MetricList and DimensionFilterList.
" - } - } - }, - "CreateAlertResponse":{ - "type":"structure", - "members":{ - "AlertArn":{ - "shape":"Arn", - "documentation":"The ARN of the alert.
" - } - } - }, - "CreateAnomalyDetectorRequest":{ - "type":"structure", - "required":[ - "AnomalyDetectorName", - "AnomalyDetectorConfig" - ], - "members":{ - "AnomalyDetectorName":{ - "shape":"AnomalyDetectorName", - "documentation":"The name of the detector.
" - }, - "AnomalyDetectorDescription":{ - "shape":"AnomalyDetectorDescription", - "documentation":"A description of the detector.
" - }, - "AnomalyDetectorConfig":{ - "shape":"AnomalyDetectorConfig", - "documentation":"Contains information about the configuration of the anomaly detector.
" - }, - "KmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"The ARN of the KMS key to use to encrypt your data.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"A list of tags to apply to the anomaly detector.
" - } - } - }, - "CreateAnomalyDetectorResponse":{ - "type":"structure", - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector.
" - } - } - }, - "CreateMetricSetRequest":{ - "type":"structure", - "required":[ - "AnomalyDetectorArn", - "MetricSetName", - "MetricList", - "MetricSource" - ], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the anomaly detector that will use the dataset.
" - }, - "MetricSetName":{ - "shape":"MetricSetName", - "documentation":"The name of the dataset.
" - }, - "MetricSetDescription":{ - "shape":"MetricSetDescription", - "documentation":"A description of the dataset you are creating.
" - }, - "MetricList":{ - "shape":"MetricList", - "documentation":"A list of metrics that the dataset will contain.
" - }, - "Offset":{ - "shape":"Offset", - "documentation":"After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
", - "box":true - }, - "TimestampColumn":{ - "shape":"TimestampColumn", - "documentation":"Contains information about the column used for tracking time in your source data.
" - }, - "DimensionList":{ - "shape":"DimensionList", - "documentation":"A list of the fields you want to treat as dimensions.
" - }, - "MetricSetFrequency":{ - "shape":"Frequency", - "documentation":"The frequency with which the source data will be analyzed for anomalies.
" - }, - "MetricSource":{ - "shape":"MetricSource", - "documentation":"Contains information about how the source data should be interpreted.
" - }, - "Timezone":{ - "shape":"Timezone", - "documentation":"The time zone in which your source data was recorded.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"A list of tags to apply to the dataset.
" - }, - "DimensionFilterList":{ - "shape":"MetricSetDimensionFilterList", - "documentation":"A list of filters that specify which data is kept for anomaly detection.
" - } - } - }, - "CreateMetricSetResponse":{ - "type":"structure", - "members":{ - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The ARN of the dataset.
" - } - } - }, - "CsvFormatDescriptor":{ - "type":"structure", - "members":{ - "FileCompression":{ - "shape":"CSVFileCompression", - "documentation":"The level of compression of the source CSV file.
" - }, - "Charset":{ - "shape":"Charset", - "documentation":"The character set in which the source CSV file is written.
" - }, - "ContainsHeader":{ - "shape":"Boolean", - "documentation":"Whether or not the source CSV file contains a header.
" - }, - "Delimiter":{ - "shape":"Delimiter", - "documentation":"The character used to delimit the source CSV file.
" - }, - "HeaderList":{ - "shape":"HeaderList", - "documentation":"A list of the source CSV file's headers, if any.
" - }, - "QuoteSymbol":{ - "shape":"QuoteSymbol", - "documentation":"The character used as a quote character.
" - } - }, - "documentation":"Contains information about how a source CSV data file should be analyzed.
" - }, - "DataItem":{"type":"string"}, - "DataQualityMetric":{ - "type":"structure", - "members":{ - "MetricType":{ - "shape":"DataQualityMetricType", - "documentation":"The name of the data quality metric.
" - }, - "MetricDescription":{ - "shape":"DataQualityMetricDescription", - "documentation":"A description of the data quality metric.
" - }, - "RelatedColumnName":{ - "shape":"RelatedColumnName", - "documentation":"The column that is being monitored.
" - }, - "MetricValue":{ - "shape":"Double", - "documentation":"The value of the data quality metric.
" - } - }, - "documentation":"An array that describes a data quality metric. Each DataQualityMetric
object contains the data quality metric name, its value, a description of the metric, and the affected column.
The Amazon Resource Name (ARN) of the anomaly detector.
" - } - } - }, - "DeactivateAnomalyDetectorResponse":{ - "type":"structure", - "members":{} - }, - "DeleteAlertRequest":{ - "type":"structure", - "required":["AlertArn"], - "members":{ - "AlertArn":{ - "shape":"Arn", - "documentation":"The ARN of the alert to delete.
" - } - } - }, - "DeleteAlertResponse":{ - "type":"structure", - "members":{} - }, - "DeleteAnomalyDetectorRequest":{ - "type":"structure", - "required":["AnomalyDetectorArn"], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector to delete.
" - } - } - }, - "DeleteAnomalyDetectorResponse":{ - "type":"structure", - "members":{} - }, - "Delimiter":{ - "type":"string", - "max":1, - "pattern":"[^\\r\\n]" - }, - "DescribeAlertRequest":{ - "type":"structure", - "required":["AlertArn"], - "members":{ - "AlertArn":{ - "shape":"Arn", - "documentation":"The ARN of the alert to describe.
" - } - } - }, - "DescribeAlertResponse":{ - "type":"structure", - "members":{ - "Alert":{ - "shape":"Alert", - "documentation":"Contains information about an alert.
" - } - } - }, - "DescribeAnomalyDetectionExecutionsRequest":{ - "type":"structure", - "required":["AnomalyDetectorArn"], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector.
" - }, - "Timestamp":{ - "shape":"TimestampString", - "documentation":"The timestamp of the anomaly detection job.
" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The number of items to return in the response.
", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token that's returned by a previous request to retrieve the next page of results.
" - } - } - }, - "DescribeAnomalyDetectionExecutionsResponse":{ - "type":"structure", - "members":{ - "ExecutionList":{ - "shape":"ExecutionList", - "documentation":"A list of detection jobs.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The pagination token that's included if more results are available.
" - } - } - }, - "DescribeAnomalyDetectorRequest":{ - "type":"structure", - "required":["AnomalyDetectorArn"], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector to describe.
" - } - } - }, - "DescribeAnomalyDetectorResponse":{ - "type":"structure", - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector.
" - }, - "AnomalyDetectorName":{ - "shape":"AnomalyDetectorName", - "documentation":"The name of the detector.
" - }, - "AnomalyDetectorDescription":{ - "shape":"AnomalyDetectorDescription", - "documentation":"A description of the detector.
" - }, - "AnomalyDetectorConfig":{ - "shape":"AnomalyDetectorConfigSummary", - "documentation":"Contains information about the detector's configuration.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the detector was created.
" - }, - "LastModificationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the detector was last modified.
" - }, - "Status":{ - "shape":"AnomalyDetectorStatus", - "documentation":"The status of the detector.
" - }, - "FailureReason":{ - "shape":"ErrorMessage", - "documentation":"The reason that the detector failed.
" - }, - "KmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"The ARN of the KMS key to use to encrypt your data.
" - }, - "FailureType":{ - "shape":"AnomalyDetectorFailureType", - "documentation":"The process that caused the detector to fail.
" - } - } - }, - "DescribeMetricSetRequest":{ - "type":"structure", - "required":["MetricSetArn"], - "members":{ - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The ARN of the dataset.
" - } - } - }, - "DescribeMetricSetResponse":{ - "type":"structure", - "members":{ - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The ARN of the dataset.
" - }, - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector that contains the dataset.
" - }, - "MetricSetName":{ - "shape":"MetricSetName", - "documentation":"The name of the dataset.
" - }, - "MetricSetDescription":{ - "shape":"MetricSetDescription", - "documentation":"The dataset's description.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the dataset was created.
" - }, - "LastModificationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the dataset was last modified.
" - }, - "Offset":{ - "shape":"Offset", - "documentation":"After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
", - "box":true - }, - "MetricList":{ - "shape":"MetricList", - "documentation":"A list of the metrics defined by the dataset.
" - }, - "TimestampColumn":{ - "shape":"TimestampColumn", - "documentation":"Contains information about the column used for tracking time in your source data.
" - }, - "DimensionList":{ - "shape":"DimensionList", - "documentation":"A list of the dimensions chosen for analysis.
" - }, - "MetricSetFrequency":{ - "shape":"Frequency", - "documentation":"The interval at which the data will be analyzed for anomalies.
" - }, - "Timezone":{ - "shape":"Timezone", - "documentation":"The time zone in which the dataset's data was recorded.
" - }, - "MetricSource":{ - "shape":"MetricSource", - "documentation":"Contains information about the dataset's source data.
" - }, - "DimensionFilterList":{ - "shape":"MetricSetDimensionFilterList", - "documentation":"The dimensions and their values that were used to filter the dataset.
" - } - } - }, - "DetectMetricSetConfigRequest":{ - "type":"structure", - "required":[ - "AnomalyDetectorArn", - "AutoDetectionMetricSource" - ], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"An anomaly detector ARN.
" - }, - "AutoDetectionMetricSource":{ - "shape":"AutoDetectionMetricSource", - "documentation":"A data source.
" - } - } - }, - "DetectMetricSetConfigResponse":{ - "type":"structure", - "members":{ - "DetectedMetricSetConfig":{ - "shape":"DetectedMetricSetConfig", - "documentation":"The inferred dataset configuration for the datasource.
" - } - } - }, - "DetectedCsvFormatDescriptor":{ - "type":"structure", - "members":{ - "FileCompression":{ - "shape":"DetectedField", - "documentation":"The format's file compression.
" - }, - "Charset":{ - "shape":"DetectedField", - "documentation":"The format's charset.
" - }, - "ContainsHeader":{ - "shape":"DetectedField", - "documentation":"Whether the format includes a header.
" - }, - "Delimiter":{ - "shape":"DetectedField", - "documentation":"The format's delimiter.
" - }, - "HeaderList":{ - "shape":"DetectedField", - "documentation":"The format's header list.
" - }, - "QuoteSymbol":{ - "shape":"DetectedField", - "documentation":"The format's quote symbol.
" - } - }, - "documentation":"Properties of an inferred CSV format.
" - }, - "DetectedField":{ - "type":"structure", - "members":{ - "Value":{ - "shape":"AttributeValue", - "documentation":"The field's value.
" - }, - "Confidence":{ - "shape":"Confidence", - "documentation":"The field's confidence.
" - }, - "Message":{ - "shape":"Message", - "documentation":"The field's message.
" - } - }, - "documentation":"An inferred field.
" - }, - "DetectedFileFormatDescriptor":{ - "type":"structure", - "members":{ - "CsvFormatDescriptor":{ - "shape":"DetectedCsvFormatDescriptor", - "documentation":"Details about a CSV format.
" - }, - "JsonFormatDescriptor":{ - "shape":"DetectedJsonFormatDescriptor", - "documentation":"Details about a JSON format.
" - } - }, - "documentation":"Properties of an inferred data format.
" - }, - "DetectedJsonFormatDescriptor":{ - "type":"structure", - "members":{ - "FileCompression":{ - "shape":"DetectedField", - "documentation":"The format's file compression.
" - }, - "Charset":{ - "shape":"DetectedField", - "documentation":"The format's character set.
" - } - }, - "documentation":"A detected JSON format descriptor.
" - }, - "DetectedMetricSetConfig":{ - "type":"structure", - "members":{ - "Offset":{ - "shape":"DetectedField", - "documentation":"The dataset's offset.
" - }, - "MetricSetFrequency":{ - "shape":"DetectedField", - "documentation":"The dataset's interval.
" - }, - "MetricSource":{ - "shape":"DetectedMetricSource", - "documentation":"The dataset's data source.
" - } - }, - "documentation":"An inferred dataset configuration.
" - }, - "DetectedMetricSource":{ - "type":"structure", - "members":{ - "S3SourceConfig":{ - "shape":"DetectedS3SourceConfig", - "documentation":"The data source's source configuration.
" - } - }, - "documentation":"An inferred data source.
" - }, - "DetectedS3SourceConfig":{ - "type":"structure", - "members":{ - "FileFormatDescriptor":{ - "shape":"DetectedFileFormatDescriptor", - "documentation":"The source's file format descriptor.
" - } - }, - "documentation":"An inferred source configuration.
" - }, - "DimensionContribution":{ - "type":"structure", - "members":{ - "DimensionName":{ - "shape":"ColumnName", - "documentation":"The name of the dimension.
" - }, - "DimensionValueContributionList":{ - "shape":"DimensionValueContributionList", - "documentation":"A list of dimension values that contributed to the anomaly.
" - } - }, - "documentation":"Details about a dimension that contributed to an anomaly.
" - }, - "DimensionContributionList":{ - "type":"list", - "member":{"shape":"DimensionContribution"} - }, - "DimensionFilter":{ - "type":"structure", - "members":{ - "DimensionName":{ - "shape":"ColumnName", - "documentation":"The name of the dimension to filter on.
" - }, - "DimensionValueList":{ - "shape":"DimensionValueList", - "documentation":"The list of values for the dimension specified in DimensionName that you want to filter on.
" - } - }, - "documentation":"The dimension filter, containing DimensionName and DimensionValueList.
" - }, - "DimensionFilterList":{ - "type":"list", - "member":{"shape":"DimensionFilter"}, - "max":5, - "min":1 - }, - "DimensionList":{ - "type":"list", - "member":{"shape":"ColumnName"}, - "min":1 - }, - "DimensionNameValue":{ - "type":"structure", - "required":[ - "DimensionName", - "DimensionValue" - ], - "members":{ - "DimensionName":{ - "shape":"ColumnName", - "documentation":"The name of the dimension.
" - }, - "DimensionValue":{ - "shape":"DimensionValue", - "documentation":"The value of the dimension.
" - } - }, - "documentation":"A dimension name and value.
" - }, - "DimensionNameValueList":{ - "type":"list", - "member":{"shape":"DimensionNameValue"} - }, - "DimensionValue":{"type":"string"}, - "DimensionValueContribution":{ - "type":"structure", - "members":{ - "DimensionValue":{ - "shape":"DimensionValue", - "documentation":"The value of the dimension.
" - }, - "ContributionScore":{ - "shape":"Score", - "documentation":"The severity score of the value.
" - } - }, - "documentation":"The severity of a value of a dimension that contributed to an anomaly.
" - }, - "DimensionValueContributionList":{ - "type":"list", - "member":{"shape":"DimensionValueContribution"} - }, - "DimensionValueList":{ - "type":"list", - "member":{"shape":"DimensionValue"}, - "max":10, - "min":1 - }, - "Double":{"type":"double"}, - "ErrorMessage":{ - "type":"string", - "max":256 - }, - "ExecutionList":{ - "type":"list", - "member":{"shape":"ExecutionStatus"} - }, - "ExecutionStatus":{ - "type":"structure", - "members":{ - "Timestamp":{ - "shape":"TimestampString", - "documentation":"The run's timestamp.
" - }, - "Status":{ - "shape":"AnomalyDetectionTaskStatus", - "documentation":"The run's status.
" - }, - "FailureReason":{ - "shape":"AnomalyDetectionTaskStatusMessage", - "documentation":"The reason that the run failed, if applicable.
" - } - }, - "documentation":"The status of an anomaly detector run.
" - }, - "FieldName":{"type":"string"}, - "FileFormatDescriptor":{ - "type":"structure", - "members":{ - "CsvFormatDescriptor":{ - "shape":"CsvFormatDescriptor", - "documentation":"Contains information about how a source CSV data file should be analyzed.
" - }, - "JsonFormatDescriptor":{ - "shape":"JsonFormatDescriptor", - "documentation":"Contains information about how a source JSON data file should be analyzed.
" - } - }, - "documentation":"Contains information about a source file's formatting.
" - }, - "Filter":{ - "type":"structure", - "members":{ - "DimensionValue":{ - "shape":"DimensionValue", - "documentation":"The value that you want to include in the filter.
" - }, - "FilterOperation":{ - "shape":"FilterOperation", - "documentation":"The condition to apply.
" - } - }, - "documentation":"Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation
object.
The ID of the anomaly group.
" - }, - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector.
" - } - } - }, - "GetAnomalyGroupResponse":{ - "type":"structure", - "members":{ - "AnomalyGroup":{ - "shape":"AnomalyGroup", - "documentation":"Details about the anomaly group.
" - } - } - }, - "GetDataQualityMetricsRequest":{ - "type":"structure", - "required":["AnomalyDetectorArn"], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.
" - }, - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of a specific data quality metric set.
" - } - } - }, - "GetDataQualityMetricsResponse":{ - "type":"structure", - "members":{ - "AnomalyDetectorDataQualityMetricList":{ - "shape":"AnomalyDetectorDataQualityMetricList", - "documentation":"A list of the data quality metrics for the AnomalyDetectorArn
that you requested.
The Amazon Resource Name (ARN) of the anomaly detector.
" - }, - "AnomalyGroupTimeSeriesFeedback":{ - "shape":"AnomalyGroupTimeSeries", - "documentation":"The anomalous metric and group ID.
" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return.
", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token that's returned by a previous request to retrieve the next page of results.
" - } - } - }, - "GetFeedbackResponse":{ - "type":"structure", - "members":{ - "AnomalyGroupTimeSeriesFeedback":{ - "shape":"TimeSeriesFeedbackList", - "documentation":"Feedback for an anomalous metric.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The pagination token that's included if more results are available.
" - } - } - }, - "GetSampleDataRequest":{ - "type":"structure", - "members":{ - "S3SourceConfig":{ - "shape":"SampleDataS3SourceConfig", - "documentation":"A datasource bucket in Amazon S3.
" - } - } - }, - "GetSampleDataResponse":{ - "type":"structure", - "members":{ - "HeaderValues":{ - "shape":"HeaderValueList", - "documentation":"A list of header labels for the records.
" - }, - "SampleRows":{ - "shape":"SampleRows", - "documentation":"A list of records.
" - } - } - }, - "HeaderList":{ - "type":"list", - "member":{"shape":"ColumnName"} - }, - "HeaderValue":{"type":"string"}, - "HeaderValueList":{ - "type":"list", - "member":{"shape":"HeaderValue"} - }, - "HistoricalDataPath":{ - "type":"string", - "max":1024, - "pattern":"^s3://[a-z0-9].+$" - }, - "HistoricalDataPathList":{ - "type":"list", - "member":{"shape":"HistoricalDataPath"}, - "max":1, - "min":1 - }, - "Integer":{"type":"integer"}, - "InterMetricImpactDetails":{ - "type":"structure", - "members":{ - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the measure.
" - }, - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "RelationshipType":{ - "shape":"RelationshipType", - "documentation":"Whether a measure is a potential cause of the anomaly group (CAUSE_OF_INPUT_ANOMALY_GROUP
), or whether the measure is impacted by the anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP
).
For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP
), the percentage contribution the measure has in causing the anomalies.
Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
" - }, - "InterMetricImpactList":{ - "type":"list", - "member":{"shape":"InterMetricImpactDetails"} - }, - "InternalServerException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"Message"} - }, - "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "ItemizedMetricStats":{ - "type":"structure", - "members":{ - "MetricName":{ - "shape":"ColumnName", - "documentation":"The name of the measure.
" - }, - "OccurrenceCount":{ - "shape":"Integer", - "documentation":"The number of times that the measure appears.
" - } - }, - "documentation":"Aggregated statistics about a measure affected by an anomaly.
" - }, - "ItemizedMetricStatsList":{ - "type":"list", - "member":{"shape":"ItemizedMetricStats"} - }, - "JsonFileCompression":{ - "type":"string", - "enum":[ - "NONE", - "GZIP" - ] - }, - "JsonFormatDescriptor":{ - "type":"structure", - "members":{ - "FileCompression":{ - "shape":"JsonFileCompression", - "documentation":"The level of compression of the source CSV file.
" - }, - "Charset":{ - "shape":"Charset", - "documentation":"The character set in which the source JSON file is written.
" - } - }, - "documentation":"Contains information about how a source JSON data file should be analyzed.
" - }, - "KmsKeyArn":{ - "type":"string", - "max":2048, - "min":20, - "pattern":"arn:aws.*:kms:.*:[0-9]{12}:key/[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" - }, - "LambdaConfiguration":{ - "type":"structure", - "required":[ - "RoleArn", - "LambdaArn" - ], - "members":{ - "RoleArn":{ - "shape":"Arn", - "documentation":"The ARN of an IAM role that has permission to invoke the Lambda function.
" - }, - "LambdaArn":{ - "shape":"Arn", - "documentation":"The ARN of the Lambda function.
" - } - }, - "documentation":"Contains information about a Lambda configuration.
" - }, - "ListAlertsRequest":{ - "type":"structure", - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the alert's detector.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If the result of the previous request is truncated, the response includes a NextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
The maximum number of results that will be displayed by the request.
", - "box":true - } - } - }, - "ListAlertsResponse":{ - "type":"structure", - "members":{ - "AlertSummaryList":{ - "shape":"AlertSummaryList", - "documentation":"Contains information about an alert.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.
" - } - } - }, - "ListAnomalyDetectorsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return.
", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If the result of the previous request was truncated, the response includes a NextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
A list of anomaly detectors in the account in the current region.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request.
" - } - } - }, - "ListAnomalyGroupRelatedMetricsRequest":{ - "type":"structure", - "required":[ - "AnomalyDetectorArn", - "AnomalyGroupId" - ], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector.
" - }, - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "RelationshipTypeFilter":{ - "shape":"RelationshipType", - "documentation":"Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP
) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP
) of the anomaly group.
The maximum number of results to return.
", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token that's returned by a previous request to retrieve the next page of results.
" - } - } - }, - "ListAnomalyGroupRelatedMetricsResponse":{ - "type":"structure", - "members":{ - "InterMetricImpactList":{ - "shape":"InterMetricImpactList", - "documentation":"Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The pagination token that's included if more results are available.
" - } - } - }, - "ListAnomalyGroupSummariesRequest":{ - "type":"structure", - "required":[ - "AnomalyDetectorArn", - "SensitivityThreshold" - ], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector.
" - }, - "SensitivityThreshold":{ - "shape":"SensitivityThreshold", - "documentation":"The minimum severity score for inclusion in the output.
" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return.
", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token that's returned by a previous request to retrieve the next page of results.
" - } - } - }, - "ListAnomalyGroupSummariesResponse":{ - "type":"structure", - "members":{ - "AnomalyGroupSummaryList":{ - "shape":"AnomalyGroupSummaryList", - "documentation":"A list of anomaly group summaries.
" - }, - "AnomalyGroupStatistics":{ - "shape":"AnomalyGroupStatistics", - "documentation":"Aggregated details about the anomaly groups.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The pagination token that's included if more results are available.
" - } - } - }, - "ListAnomalyGroupTimeSeriesRequest":{ - "type":"structure", - "required":[ - "AnomalyDetectorArn", - "AnomalyGroupId", - "MetricName" - ], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector.
" - }, - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the measure field.
" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return.
", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token that's returned by a previous request to retrieve the next page of results.
" - } - } - }, - "ListAnomalyGroupTimeSeriesResponse":{ - "type":"structure", - "members":{ - "AnomalyGroupId":{ - "shape":"UUID", - "documentation":"The ID of the anomaly group.
" - }, - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the measure field.
" - }, - "TimestampList":{ - "shape":"TimestampList", - "documentation":"Timestamps for the anomalous metrics.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"The pagination token that's included if more results are available.
" - }, - "TimeSeriesList":{ - "shape":"TimeSeriesList", - "documentation":"A list of anomalous metrics.
" - } - } - }, - "ListMetricSetsRequest":{ - "type":"structure", - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the anomaly detector containing the metrics sets to list.
" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return.
", - "box":true - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If the result of the previous request was truncated, the response includes a NextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
A list of the datasets in the AWS Region, with configuration details for each.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If the response is truncated, the list call returns this token. To retrieve the next set of results, use the token in the next list request.
" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"Arn", - "documentation":"The resource's Amazon Resource Name (ARN).
", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagMap", - "documentation":"The resource's tags.
", - "locationName":"Tags" - } - } - }, - "MaxResults":{ - "type":"integer", - "max":100, - "min":1 - }, - "Message":{"type":"string"}, - "Metric":{ - "type":"structure", - "required":[ - "MetricName", - "AggregationFunction" - ], - "members":{ - "MetricName":{ - "shape":"ColumnName", - "documentation":"The name of the metric.
" - }, - "AggregationFunction":{ - "shape":"AggregationFunction", - "documentation":"The function with which the metric is calculated.
" - }, - "Namespace":{ - "shape":"Namespace", - "documentation":"The namespace for the metric.
" - } - }, - "documentation":"A calculation made by contrasting a measure and a dimension from your source data.
" - }, - "MetricChangePercentage":{ - "type":"double", - "max":100.0, - "min":0.0 - }, - "MetricLevelImpact":{ - "type":"structure", - "members":{ - "MetricName":{ - "shape":"MetricName", - "documentation":"The name of the measure.
" - }, - "NumTimeSeries":{ - "shape":"Integer", - "documentation":"The number of anomalous metrics for the measure.
" - }, - "ContributionMatrix":{ - "shape":"ContributionMatrix", - "documentation":"Details about the dimensions that contributed to the anomaly.
" - } - }, - "documentation":"Details about a measure affected by an anomaly.
" - }, - "MetricLevelImpactList":{ - "type":"list", - "member":{"shape":"MetricLevelImpact"} - }, - "MetricList":{ - "type":"list", - "member":{"shape":"Metric"}, - "min":1 - }, - "MetricName":{ - "type":"string", - "max":256, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" - }, - "MetricNameList":{ - "type":"list", - "member":{"shape":"MetricName"}, - "max":5, - "min":1 - }, - "MetricSetDataQualityMetric":{ - "type":"structure", - "members":{ - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the data quality metric array.
" - }, - "DataQualityMetricList":{ - "shape":"DataQualityMetricList", - "documentation":"The array of data quality metrics contained in the data quality metric set.
" - } - }, - "documentation":"An array of DataQualityMetric
objects that describes one or more data quality metrics.
The dimension that you want to filter on.
" - }, - "FilterList":{ - "shape":"FilterList", - "documentation":"The list of filters that you are applying.
" - } - }, - "documentation":"Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.
" - }, - "MetricSetDimensionFilterList":{ - "type":"list", - "member":{"shape":"MetricSetDimensionFilter"} - }, - "MetricSetName":{ - "type":"string", - "max":63, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" - }, - "MetricSetSummary":{ - "type":"structure", - "members":{ - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The ARN of the dataset.
" - }, - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector to which the dataset belongs.
" - }, - "MetricSetDescription":{ - "shape":"MetricSetDescription", - "documentation":"The description of the dataset.
" - }, - "MetricSetName":{ - "shape":"MetricSetName", - "documentation":"The name of the dataset.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the dataset was created.
" - }, - "LastModificationTime":{ - "shape":"Timestamp", - "documentation":"The time at which the dataset was last modified.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The dataset's tags.
" - } - }, - "documentation":"Contains information about a dataset.
" - }, - "MetricSetSummaryList":{ - "type":"list", - "member":{"shape":"MetricSetSummary"} - }, - "MetricSource":{ - "type":"structure", - "members":{ - "S3SourceConfig":{"shape":"S3SourceConfig"}, - "AppFlowConfig":{ - "shape":"AppFlowConfig", - "documentation":"Details about an AppFlow datasource.
" - }, - "CloudWatchConfig":{ - "shape":"CloudWatchConfig", - "documentation":"Details about an Amazon CloudWatch monitoring datasource.
" - }, - "RDSSourceConfig":{ - "shape":"RDSSourceConfig", - "documentation":"Details about an Amazon Relational Database Service (RDS) datasource.
" - }, - "RedshiftSourceConfig":{ - "shape":"RedshiftSourceConfig", - "documentation":"Details about an Amazon Redshift database datasource.
" - }, - "AthenaSourceConfig":{ - "shape":"AthenaSourceConfig", - "documentation":"Details about an Amazon Athena datasource.
" - } - }, - "documentation":"Contains information about source data used to generate metrics.
" - }, - "MetricValue":{"type":"double"}, - "MetricValueList":{ - "type":"list", - "member":{"shape":"MetricValue"} - }, - "Namespace":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[^:].*" - }, - "NextToken":{ - "type":"string", - "max":3000, - "min":1, - "pattern":".*\\S.*" - }, - "NumberAttributeValue":{"type":"string"}, - "NumberListAttributeValue":{ - "type":"list", - "member":{"shape":"NumberAttributeValue"} - }, - "Offset":{ - "type":"integer", - "max":432000, - "min":0 - }, - "PoirotSecretManagerArn":{ - "type":"string", - "max":256, - "pattern":"arn:([a-z\\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+" - }, - "PutFeedbackRequest":{ - "type":"structure", - "required":[ - "AnomalyDetectorArn", - "AnomalyGroupTimeSeriesFeedback" - ], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the anomaly detector.
" - }, - "AnomalyGroupTimeSeriesFeedback":{ - "shape":"AnomalyGroupTimeSeriesFeedback", - "documentation":"Feedback for an anomalous metric.
" - } - } - }, - "PutFeedbackResponse":{ - "type":"structure", - "members":{} - }, - "QuotaCode":{"type":"string"}, - "QuoteSymbol":{ - "type":"string", - "max":1, - "pattern":"[^\\r\\n]|^$" - }, - "RDSDatabaseIdentifier":{ - "type":"string", - "max":63, - "min":1, - "pattern":"^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\\-]*$" - }, - "RDSDatabaseName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9_.]+" - }, - "RDSSourceConfig":{ - "type":"structure", - "members":{ - "DBInstanceIdentifier":{ - "shape":"RDSDatabaseIdentifier", - "documentation":"A string identifying the database instance.
" - }, - "DatabaseHost":{ - "shape":"DatabaseHost", - "documentation":"The host name of the database.
" - }, - "DatabasePort":{ - "shape":"DatabasePort", - "documentation":"The port number where the database can be accessed.
", - "box":true - }, - "SecretManagerArn":{ - "shape":"PoirotSecretManagerArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
" - }, - "DatabaseName":{ - "shape":"RDSDatabaseName", - "documentation":"The name of the RDS database.
" - }, - "TableName":{ - "shape":"TableName", - "documentation":"The name of the table in the database.
" - }, - "RoleArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the role.
" - }, - "VpcConfiguration":{ - "shape":"VpcConfiguration", - "documentation":"An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
" - } - }, - "documentation":"Contains information about the Amazon Relational Database Service (RDS) configuration.
" - }, - "RedshiftClusterIdentifier":{ - "type":"string", - "max":63, - "min":1, - "pattern":"^[a-z](?!.*--)(?!.*-$)[0-9a-z\\-]*$" - }, - "RedshiftDatabaseName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"[a-zA-Z0-9_.]+" - }, - "RedshiftSourceConfig":{ - "type":"structure", - "members":{ - "ClusterIdentifier":{ - "shape":"RedshiftClusterIdentifier", - "documentation":"A string identifying the Redshift cluster.
" - }, - "DatabaseHost":{ - "shape":"DatabaseHost", - "documentation":"The name of the database host.
" - }, - "DatabasePort":{ - "shape":"DatabasePort", - "documentation":"The port number where the database can be accessed.
", - "box":true - }, - "SecretManagerArn":{ - "shape":"PoirotSecretManagerArn", - "documentation":"The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
" - }, - "DatabaseName":{ - "shape":"RedshiftDatabaseName", - "documentation":"The Redshift database name.
" - }, - "TableName":{ - "shape":"TableName", - "documentation":"The table name of the Redshift database.
" - }, - "RoleArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the role providing access to the database.
" - }, - "VpcConfiguration":{ - "shape":"VpcConfiguration", - "documentation":"Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
" - } - }, - "documentation":"Provides information about the Amazon Redshift database configuration.
" - }, - "RelatedColumnName":{ - "type":"string", - "max":256, - "min":1, - "pattern":".*\\S.*" - }, - "RelationshipType":{ - "type":"string", - "enum":[ - "CAUSE_OF_INPUT_ANOMALY_GROUP", - "EFFECT_OF_INPUT_ANOMALY_GROUP" - ] - }, - "ResourceId":{"type":"string"}, - "ResourceNotFoundException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"Message"}, - "ResourceId":{ - "shape":"ResourceId", - "documentation":"The ID of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of the resource.
" - } - }, - "documentation":"The specified resource cannot be found. Check the ARN of the resource and try again.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "ResourceType":{"type":"string"}, - "S3SourceConfig":{ - "type":"structure", - "members":{ - "RoleArn":{ - "shape":"Arn", - "documentation":"The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
" - }, - "TemplatedPathList":{ - "shape":"TemplatedPathList", - "documentation":"A list of templated paths to the source files.
" - }, - "HistoricalDataPathList":{ - "shape":"HistoricalDataPathList", - "documentation":"A list of paths to the historical data files.
" - }, - "FileFormatDescriptor":{ - "shape":"FileFormatDescriptor", - "documentation":"Contains information about a source file's formatting.
" - } - }, - "documentation":"Contains information about the configuration of the S3 bucket that contains source files.
" - }, - "SNSConfiguration":{ - "type":"structure", - "required":[ - "RoleArn", - "SnsTopicArn" - ], - "members":{ - "RoleArn":{ - "shape":"Arn", - "documentation":"The ARN of the IAM role that has access to the target SNS topic.
" - }, - "SnsTopicArn":{ - "shape":"Arn", - "documentation":"The ARN of the target SNS topic.
" - }, - "SnsFormat":{ - "shape":"SnsFormat", - "documentation":"The format of the SNS topic.
JSON
– Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.
LONG_TEXT
– Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.
SHORT_TEXT
– Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.
Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.
" - }, - "SampleDataS3SourceConfig":{ - "type":"structure", - "required":[ - "RoleArn", - "FileFormatDescriptor" - ], - "members":{ - "RoleArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the role.
" - }, - "TemplatedPathList":{ - "shape":"TemplatedPathList", - "documentation":"An array of strings containing the list of templated paths.
" - }, - "HistoricalDataPathList":{ - "shape":"HistoricalDataPathList", - "documentation":"An array of strings containing the historical set of data paths.
" - }, - "FileFormatDescriptor":{"shape":"FileFormatDescriptor"} - }, - "documentation":"Contains information about the source configuration in Amazon S3.
" - }, - "SampleRow":{ - "type":"list", - "member":{"shape":"DataItem"} - }, - "SampleRows":{ - "type":"list", - "member":{"shape":"SampleRow"} - }, - "Score":{ - "type":"double", - "max":100.0, - "min":0.0 - }, - "SecurityGroupId":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[-0-9a-zA-Z]+" - }, - "SecurityGroupIdList":{ - "type":"list", - "member":{"shape":"SecurityGroupId"} - }, - "SensitivityThreshold":{ - "type":"integer", - "max":100, - "min":0 - }, - "ServiceCode":{"type":"string"}, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"Message"}, - "ResourceId":{ - "shape":"ResourceId", - "documentation":"The ID of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of the resource.
" - }, - "QuotaCode":{ - "shape":"QuotaCode", - "documentation":"The quota code.
" - }, - "ServiceCode":{ - "shape":"ServiceCode", - "documentation":"The service code.
" - } - }, - "documentation":"The request exceeded the service's quotas. Check the service quotas and try again.
", - "error":{"httpStatusCode":402}, - "exception":true - }, - "SnsFormat":{ - "type":"string", - "enum":[ - "LONG_TEXT", - "SHORT_TEXT", - "JSON" - ] - }, - "StringAttributeValue":{"type":"string"}, - "StringListAttributeValue":{ - "type":"list", - "member":{"shape":"StringAttributeValue"} - }, - "SubnetId":{ - "type":"string", - "max":255, - "pattern":"[\\-0-9a-zA-Z]+" - }, - "SubnetIdList":{ - "type":"list", - "member":{"shape":"SubnetId"} - }, - "TableName":{ - "type":"string", - "max":100, - "min":1, - "pattern":"^[a-zA-Z][a-zA-Z0-9_.]*$" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1 - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":50, - "min":1 - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":1 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{ - "shape":"Arn", - "documentation":"The resource's Amazon Resource Name (ARN).
", - "location":"uri", - "locationName":"resourceArn" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-
The ID of the metric.
" - }, - "DimensionList":{ - "shape":"DimensionNameValueList", - "documentation":"The dimensions of the metric.
" - }, - "MetricValueList":{ - "shape":"MetricValueList", - "documentation":"The values for the metric.
" - } - }, - "documentation":"Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.
" - }, - "TimeSeriesFeedback":{ - "type":"structure", - "members":{ - "TimeSeriesId":{ - "shape":"TimeSeriesId", - "documentation":"The ID of the metric.
" - }, - "IsAnomaly":{ - "shape":"Boolean", - "documentation":"Feedback on whether the metric is a legitimate anomaly.
" - } - }, - "documentation":"Details about feedback submitted for an anomalous metric.
" - }, - "TimeSeriesFeedbackList":{ - "type":"list", - "member":{"shape":"TimeSeriesFeedback"} - }, - "TimeSeriesId":{ - "type":"string", - "max":520, - "pattern":".*\\S.*" - }, - "TimeSeriesList":{ - "type":"list", - "member":{"shape":"TimeSeries"} - }, - "Timestamp":{"type":"timestamp"}, - "TimestampColumn":{ - "type":"structure", - "members":{ - "ColumnName":{ - "shape":"ColumnName", - "documentation":"The name of the timestamp column.
" - }, - "ColumnFormat":{ - "shape":"DateTimeFormat", - "documentation":"The format of the timestamp column.
" - } - }, - "documentation":"Contains information about the column used to track time in a source data file.
" - }, - "TimestampList":{ - "type":"list", - "member":{"shape":"TimestampString"} - }, - "TimestampString":{ - "type":"string", - "max":60, - "pattern":"^([12]\\d{3})-(1[0-2]|0[1-9])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)(Z|(\\+|\\-)(0\\d|1[0-2]):([0-5]\\d)(\\[[[:alnum:]\\/\\_]+\\])?)$" - }, - "Timezone":{ - "type":"string", - "max":60, - "pattern":".*\\S.*" - }, - "TooManyRequestsException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"Message"} - }, - "documentation":"The request was denied due to too many requests being submitted at the same time.
", - "error":{"httpStatusCode":429}, - "exception":true - }, - "UUID":{ - "type":"string", - "max":63, - "pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{ - "shape":"Arn", - "documentation":"The resource's Amazon Resource Name (ARN).
", - "location":"uri", - "locationName":"resourceArn" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"Keys to remove from the resource's tags.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateAlertRequest":{ - "type":"structure", - "required":["AlertArn"], - "members":{ - "AlertArn":{ - "shape":"Arn", - "documentation":"The ARN of the alert to update.
" - }, - "AlertDescription":{ - "shape":"AlertDescription", - "documentation":"A description of the alert.
" - }, - "AlertSensitivityThreshold":{ - "shape":"SensitivityThreshold", - "documentation":"An integer from 0 to 100 specifying the alert sensitivity threshold.
" - }, - "Action":{ - "shape":"Action", - "documentation":"Action that will be triggered when there is an alert.
" - }, - "AlertFilters":{ - "shape":"AlertFilters", - "documentation":"The configuration of the alert filters, containing MetricList and DimensionFilterList.
" - } - } - }, - "UpdateAlertResponse":{ - "type":"structure", - "members":{ - "AlertArn":{ - "shape":"Arn", - "documentation":"The ARN of the updated alert.
" - } - } - }, - "UpdateAnomalyDetectorRequest":{ - "type":"structure", - "required":["AnomalyDetectorArn"], - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the detector to update.
" - }, - "KmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"The Amazon Resource Name (ARN) of an AWS KMS encryption key.
" - }, - "AnomalyDetectorDescription":{ - "shape":"AnomalyDetectorDescription", - "documentation":"The updated detector description.
" - }, - "AnomalyDetectorConfig":{ - "shape":"AnomalyDetectorConfig", - "documentation":"Contains information about the configuration to which the detector will be updated.
" - } - } - }, - "UpdateAnomalyDetectorResponse":{ - "type":"structure", - "members":{ - "AnomalyDetectorArn":{ - "shape":"Arn", - "documentation":"The ARN of the updated detector.
" - } - } - }, - "UpdateMetricSetRequest":{ - "type":"structure", - "required":["MetricSetArn"], - "members":{ - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The ARN of the dataset to update.
" - }, - "MetricSetDescription":{ - "shape":"MetricSetDescription", - "documentation":"The dataset's description.
" - }, - "MetricList":{ - "shape":"MetricList", - "documentation":"The metric list.
" - }, - "Offset":{ - "shape":"Offset", - "documentation":"After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
", - "box":true - }, - "TimestampColumn":{ - "shape":"TimestampColumn", - "documentation":"The timestamp column.
" - }, - "DimensionList":{ - "shape":"DimensionList", - "documentation":"The dimension list.
" - }, - "MetricSetFrequency":{ - "shape":"Frequency", - "documentation":"The dataset's interval.
" - }, - "MetricSource":{"shape":"MetricSource"}, - "DimensionFilterList":{ - "shape":"MetricSetDimensionFilterList", - "documentation":"Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.
" - } - } - }, - "UpdateMetricSetResponse":{ - "type":"structure", - "members":{ - "MetricSetArn":{ - "shape":"Arn", - "documentation":"The ARN of the dataset.
" - } - } - }, - "ValidationException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"Message"}, - "Reason":{ - "shape":"ValidationExceptionReason", - "documentation":"The reason that validation failed.
" - }, - "Fields":{ - "shape":"ValidationExceptionFieldList", - "documentation":"Fields that failed validation.
" - } - }, - "documentation":"The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "Name", - "Message" - ], - "members":{ - "Name":{ - "shape":"FieldName", - "documentation":"The name of the field.
" - }, - "Message":{ - "shape":"Message", - "documentation":"The message with more information about the validation exception.
" - } - }, - "documentation":"Contains information about a a field in a validation exception.
" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "UNKNOWN_OPERATION", - "CANNOT_PARSE", - "FIELD_VALIDATION_FAILED", - "OTHER" - ] - }, - "VpcConfiguration":{ - "type":"structure", - "required":[ - "SubnetIdList", - "SecurityGroupIdList" - ], - "members":{ - "SubnetIdList":{ - "shape":"SubnetIdList", - "documentation":"An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE
.
An array of strings containing the list of security groups.
" - } - }, - "documentation":"Contains configuration information about the Amazon Virtual Private Cloud (VPC).
" - } - }, - "documentation":"This is the Amazon Lookout for Metrics API Reference. For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide.
" -} diff --git a/awscli/botocore/data/lookoutvision/2020-11-20/endpoint-rule-set-1.json b/awscli/botocore/data/lookoutvision/2020-11-20/endpoint-rule-set-1.json deleted file mode 100644 index 9258c204ae10..000000000000 --- a/awscli/botocore/data/lookoutvision/2020-11-20/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/lookoutvision/2020-11-20/paginators-1.json b/awscli/botocore/data/lookoutvision/2020-11-20/paginators-1.json deleted file mode 100644 index 14c4ce73905b..000000000000 --- a/awscli/botocore/data/lookoutvision/2020-11-20/paginators-1.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "pagination": { - "ListDatasetEntries": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "DatasetEntries" - }, - "ListModels": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Models" - }, - "ListProjects": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Projects" - }, - "ListModelPackagingJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "ModelPackagingJobs" - } - } -} diff --git a/awscli/botocore/data/lookoutvision/2020-11-20/service-2.json b/awscli/botocore/data/lookoutvision/2020-11-20/service-2.json deleted file mode 100644 index e0109583304b..000000000000 --- a/awscli/botocore/data/lookoutvision/2020-11-20/service-2.json +++ /dev/null @@ -1,2265 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2020-11-20", - "endpointPrefix":"lookoutvision", - "jsonVersion":"1.1", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"Amazon Lookout for Vision", - "serviceId":"LookoutVision", - "signatureVersion":"v4", - "signingName":"lookoutvision", - "uid":"lookoutvision-2020-11-20", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "CreateDataset":{ - "name":"CreateDataset", - "http":{ - "method":"POST", - "requestUri":"/2020-11-20/projects/{projectName}/datasets", - "responseCode":202 - }, - "input":{"shape":"CreateDatasetRequest"}, - "output":{"shape":"CreateDatasetResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"ServiceQuotaExceededException"} - ], - "documentation":"Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset
can create a training or a test dataset from a valid dataset source (DatasetSource
).
If you want a single dataset project, specify train
for the value of DatasetType
.
To have a project with separate training and test datasets, call CreateDataset
twice. On the first call, specify train
for the value of DatasetType
. On the second call, specify test
for the value of DatasetType
.
This operation requires permissions to perform the lookoutvision:CreateDataset
operation.
Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel
is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.
To get the current status, check the Status
field returned in the response from DescribeModel.
If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.
After training completes, the evaluation metrics are stored at the location specified in OutputConfig
.
This operation requires permissions to perform the lookoutvision:CreateModel
operation. If you want to tag your model, you also require permission to the lookoutvision:TagResource
operation.
Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset.
This operation requires permissions to perform the lookoutvision:CreateProject
operation.
Deletes an existing Amazon Lookout for Vision dataset
.
If your the project has a single dataset, you must create a new dataset before you can create a model.
If you project has a training dataset and a test dataset consider the following.
If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.
If you delete the training dataset, you must create a training dataset before you can create a model.
This operation requires permissions to perform the lookoutvision:DeleteDataset
operation.
Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation.
It might take a few seconds to delete a model. To determine if a model has been deleted, call ListModels and check if the version of the model (ModelVersion
) is in the Models
array.
This operation requires permissions to perform the lookoutvision:DeleteModel
operation.
Deletes an Amazon Lookout for Vision project.
To delete a project, you must first delete each version of the model associated with the project. To delete a model use the DeleteModel operation.
You also have to delete the dataset(s) associated with the model. For more information, see DeleteDataset. The images referenced by the training and test datasets aren't deleted.
This operation requires permissions to perform the lookoutvision:DeleteProject
operation.
Describe an Amazon Lookout for Vision dataset.
This operation requires permissions to perform the lookoutvision:DescribeDataset
operation.
Describes a version of an Amazon Lookout for Vision model.
This operation requires permissions to perform the lookoutvision:DescribeModel
operation.
Describes an Amazon Lookout for Vision model packaging job.
This operation requires permissions to perform the lookoutvision:DescribeModelPackagingJob
operation.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
" - }, - "DescribeProject":{ - "name":"DescribeProject", - "http":{ - "method":"GET", - "requestUri":"/2020-11-20/projects/{projectName}" - }, - "input":{"shape":"DescribeProjectRequest"}, - "output":{"shape":"DescribeProjectResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Describes an Amazon Lookout for Vision project.
This operation requires permissions to perform the lookoutvision:DescribeProject
operation.
Detects anomalies in an image that you supply.
The response from DetectAnomalies
includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction. If the model is an image segmentation model, the response also includes segmentation information for each type of anomaly found in the image.
Before calling DetectAnomalies
, you must first start your model with the StartModel operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your model uses. If you are not using a model, use the StopModel operation to stop your model.
For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer guide.
This operation requires permissions to perform the lookoutvision:DetectAnomalies
operation.
Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.
This operation requires permissions to perform the lookoutvision:ListDatasetEntries
operation.
Lists the model packaging jobs created for an Amazon Lookout for Vision project.
This operation requires permissions to perform the lookoutvision:ListModelPackagingJobs
operation.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
" - }, - "ListModels":{ - "name":"ListModels", - "http":{ - "method":"GET", - "requestUri":"/2020-11-20/projects/{projectName}/models" - }, - "input":{"shape":"ListModelsRequest"}, - "output":{"shape":"ListModelsResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Lists the versions of a model in an Amazon Lookout for Vision project.
The ListModels
operation is eventually consistent. Recent calls to CreateModel
might take a while to appear in the response from ListProjects
.
This operation requires permissions to perform the lookoutvision:ListModels
operation.
Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects
.
The ListProjects
operation is eventually consistent. Recent calls to CreateProject
and DeleteProject
might take a while to appear in the response from ListProjects
.
This operation requires permissions to perform the lookoutvision:ListProjects
operation.
Returns a list of tags attached to the specified Amazon Lookout for Vision model.
This operation requires permissions to perform the lookoutvision:ListTagsForResource
operation.
Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use DescribeModel.
A model is ready to use when its status is HOSTED
.
Once the model is running, you can detect custom labels in new images by calling DetectAnomalies.
You are charged for the amount of time that the model is running. To stop a running model, call StopModel.
This operation requires permissions to perform the lookoutvision:StartModel
operation.
Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.
Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status
is SUCCEEDED
.
To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API.
This operation requires the following permissions:
lookoutvision:StartModelPackagingJob
s3:PutObject
s3:GetBucketLocation
kms:GenerateDataKey
greengrass:CreateComponentVersion
greengrass:DescribeComponent
(Optional) greengrass:TagResource
. Only required if you want to tag the component.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
" - }, - "StopModel":{ - "name":"StopModel", - "http":{ - "method":"POST", - "requestUri":"/2020-11-20/projects/{projectName}/models/{modelVersion}/stop", - "responseCode":202 - }, - "input":{"shape":"StopModelRequest"}, - "output":{"shape":"StopModelResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel.
After the model hosting stops, the Status
of the model is TRAINED
.
This operation requires permissions to perform the lookoutvision:StopModel
operation.
Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide.
This operation requires permissions to perform the lookoutvision:TagResource
operation.
Removes one or more tags from an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide.
This operation requires permissions to perform the lookoutvision:UntagResource
operation.
Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model.
To update an existing JSON Line, use the source-ref
field to identify the JSON Line. The JSON line that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are removed from the dataset.
For more information, see Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide.
The images you reference in the source-ref
field of a JSON line, must be in the same S3 bucket as the existing images in the dataset.
Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and check the Status
field in the response.
This operation requires permissions to perform the lookoutvision:UpdateDatasetEntries
operation.
You are not authorized to perform the action.
", - "error":{"httpStatusCode":403}, - "exception":true - }, - "Anomaly":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"AnomalyName", - "documentation":"The name of an anomaly type found in an image. Name
maps to an anomaly type in the training dataset, apart from the anomaly type background
. The service automatically inserts the background
anomaly type into the response from DetectAnomalies
.
Information about the pixel mask that covers an anomaly type.
" - } - }, - "documentation":"Information about an anomaly type found on an image by an image segmentation model. For more information, see DetectAnomalies.
" - }, - "AnomalyClassFilter":{ - "type":"string", - "max":10, - "min":1, - "pattern":"(normal|anomaly)" - }, - "AnomalyList":{ - "type":"list", - "member":{"shape":"Anomaly"} - }, - "AnomalyMask":{ - "type":"blob", - "max":5242880, - "min":1 - }, - "AnomalyName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9]*" - }, - "Boolean":{"type":"boolean"}, - "ClientToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^[a-zA-Z0-9-]+$" - }, - "Color":{ - "type":"string", - "max":7, - "min":7, - "pattern":"\\#[a-zA-Z0-9]{6}" - }, - "CompilerOptions":{ - "type":"string", - "max":1024, - "min":3, - "pattern":".*" - }, - "ComponentDescription":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9-_. ()':,;?]+" - }, - "ComponentName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9-_.]+" - }, - "ComponentVersion":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^([0-9]{1,6})\\.([0-9]{1,6})\\.([0-9]{1,6})$" - }, - "ComponentVersionArn":{ - "type":"string", - "pattern":"arn:[^:]*:greengrass:[^:]*:aws:components:[^:]+" - }, - "ConflictException":{ - "type":"structure", - "required":[ - "Message", - "ResourceId", - "ResourceType" - ], - "members":{ - "Message":{"shape":"ExceptionString"}, - "ResourceId":{ - "shape":"ExceptionString", - "documentation":"The ID of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of the resource.
" - } - }, - "documentation":"The update or deletion of a resource caused an inconsistent state.
", - "error":{"httpStatusCode":409}, - "exception":true - }, - "ContentType":{ - "type":"string", - "max":255, - "min":1, - "pattern":".*" - }, - "CreateDatasetRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "DatasetType" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project in which you want to create a dataset.
", - "location":"uri", - "locationName":"projectName" - }, - "DatasetType":{ - "shape":"DatasetType", - "documentation":"The type of the dataset. Specify train
for a training dataset. Specify test
for a test dataset.
The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.
If you don't specify DatasetSource
, an empty dataset is created and the operation synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.
If you specify a value for DataSource
, the manifest at the S3 location is validated and used to create the dataset. The call to CreateDataset
is asynchronous and might take a while to complete. To find out the current status, Check the value of Status
returned in a call to DescribeDataset.
ClientToken is an idempotency token that ensures a call to CreateDataset
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateDataset
. In this case, safely retry your call to CreateDataset
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to CreateDataset
. An idempotency token is active for 8 hours.
Information about the dataset.
" - } - } - }, - "CreateModelRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "OutputConfig" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project in which you want to create a model version.
", - "location":"uri", - "locationName":"projectName" - }, - "Description":{ - "shape":"ModelDescriptionMessage", - "documentation":"A description for the version of the model.
" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to CreateModel
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateModel
. In this case, safely retry your call to CreateModel
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from starting multiple training jobs. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to CreateModel
. An idempotency token is active for 8 hours.
The location where Amazon Lookout for Vision saves the training results.
" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"The identifier for your AWS KMS key. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A set of tags (key-value pairs) that you want to attach to the model.
" - } - } - }, - "CreateModelResponse":{ - "type":"structure", - "members":{ - "ModelMetadata":{ - "shape":"ModelMetadata", - "documentation":"The response from a call to CreateModel
.
The name for the project.
" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to CreateProject
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateProject
. In this case, safely retry your call to CreateProject
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple project creation requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to CreateProject
. An idempotency token is active for 8 hours.
Information about the project.
" - } - } - }, - "DatasetChanges":{ - "type":"blob", - "max":10485760, - "min":1 - }, - "DatasetDescription":{ - "type":"structure", - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the dataset.
" - }, - "DatasetType":{ - "shape":"DatasetType", - "documentation":"The type of the dataset. The value train
represents a training dataset or single dataset project. The value test
represents a test dataset.
The Unix timestamp for the time and date that the dataset was created.
" - }, - "LastUpdatedTimestamp":{ - "shape":"DateTime", - "documentation":"The Unix timestamp for the date and time that the dataset was last updated.
" - }, - "Status":{ - "shape":"DatasetStatus", - "documentation":"The status of the dataset.
" - }, - "StatusMessage":{ - "shape":"DatasetStatusMessage", - "documentation":"The status message for the dataset.
" - }, - "ImageStats":{ - "shape":"DatasetImageStats", - "documentation":"Statistics about the images in a dataset.
" - } - }, - "documentation":"The description for a dataset. For more information, see DescribeDataset.
" - }, - "DatasetEntry":{ - "type":"string", - "max":8192, - "min":2, - "pattern":"^\\{.*\\}$" - }, - "DatasetEntryList":{ - "type":"list", - "member":{"shape":"DatasetEntry"} - }, - "DatasetGroundTruthManifest":{ - "type":"structure", - "members":{ - "S3Object":{ - "shape":"InputS3Object", - "documentation":"The S3 bucket location for the manifest file.
" - } - }, - "documentation":"Location information about a manifest file. You can use a manifest file to create a dataset.
" - }, - "DatasetImageStats":{ - "type":"structure", - "members":{ - "Total":{ - "shape":"Integer", - "documentation":"The total number of images in the dataset.
" - }, - "Labeled":{ - "shape":"Integer", - "documentation":"The total number of labeled images.
" - }, - "Normal":{ - "shape":"Integer", - "documentation":"The total number of images labeled as normal.
" - }, - "Anomaly":{ - "shape":"Integer", - "documentation":"the total number of images labeled as an anomaly.
" - } - }, - "documentation":"Statistics about the images in a dataset.
" - }, - "DatasetMetadata":{ - "type":"structure", - "members":{ - "DatasetType":{ - "shape":"DatasetType", - "documentation":"The type of the dataset.
" - }, - "CreationTimestamp":{ - "shape":"DateTime", - "documentation":"The Unix timestamp for the date and time that the dataset was created.
" - }, - "Status":{ - "shape":"DatasetStatus", - "documentation":"The status for the dataset.
" - }, - "StatusMessage":{ - "shape":"DatasetStatusMessage", - "documentation":"The status message for the dataset.
" - } - }, - "documentation":"Summary information for an Amazon Lookout for Vision dataset. For more information, see DescribeDataset and ProjectDescription.
" - }, - "DatasetMetadataList":{ - "type":"list", - "member":{"shape":"DatasetMetadata"} - }, - "DatasetSource":{ - "type":"structure", - "members":{ - "GroundTruthManifest":{ - "shape":"DatasetGroundTruthManifest", - "documentation":"Location information for the manifest file.
" - } - }, - "documentation":"Information about the location of a manifest file that Amazon Lookout for Vision uses to to create a dataset.
" - }, - "DatasetStatus":{ - "type":"string", - "enum":[ - "CREATE_IN_PROGRESS", - "CREATE_COMPLETE", - "CREATE_FAILED", - "UPDATE_IN_PROGRESS", - "UPDATE_COMPLETE", - "UPDATE_FAILED_ROLLBACK_IN_PROGRESS", - "UPDATE_FAILED_ROLLBACK_COMPLETE", - "DELETE_IN_PROGRESS", - "DELETE_COMPLETE", - "DELETE_FAILED" - ] - }, - "DatasetStatusMessage":{"type":"string"}, - "DatasetType":{ - "type":"string", - "max":10, - "min":1, - "pattern":"train|test" - }, - "DateTime":{"type":"timestamp"}, - "DeleteDatasetRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "DatasetType" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the dataset that you want to delete.
", - "location":"uri", - "locationName":"projectName" - }, - "DatasetType":{ - "shape":"DatasetType", - "documentation":"The type of the dataset to delete. Specify train
to delete the training dataset. Specify test
to delete the test dataset. To delete the dataset in a single dataset project, specify train
.
ClientToken is an idempotency token that ensures a call to DeleteDataset
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteDataset
. In this case, safely retry your call to DeleteDataset
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple deletetion requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to DeleteDataset
. An idempotency token is active for 8 hours.
The name of the project that contains the model that you want to delete.
", - "location":"uri", - "locationName":"projectName" - }, - "ModelVersion":{ - "shape":"ModelVersionNoLatest", - "documentation":"The version of the model that you want to delete.
", - "location":"uri", - "locationName":"modelVersion" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to DeleteModel
completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from DeleteModel
. In this case, safely retry your call to DeleteModel
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple model deletion requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to DeleteModel
. An idempotency token is active for 8 hours.
The Amazon Resource Name (ARN) of the model that was deleted.
" - } - } - }, - "DeleteProjectRequest":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project to delete.
", - "location":"uri", - "locationName":"projectName" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to DeleteProject
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteProject
. In this case, safely retry your call to DeleteProject
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple project deletion requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to DeleteProject
. An idempotency token is active for 8 hours.
The Amazon Resource Name (ARN) of the project that was deleted.
" - } - } - }, - "DescribeDatasetRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "DatasetType" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the dataset that you want to describe.
", - "location":"uri", - "locationName":"projectName" - }, - "DatasetType":{ - "shape":"DatasetType", - "documentation":"The type of the dataset to describe. Specify train
to describe the training dataset. Specify test
to describe the test dataset. If you have a single dataset project, specify train
The description of the requested dataset.
" - } - } - }, - "DescribeModelPackagingJobRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "JobName" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the model packaging job that you want to describe.
", - "location":"uri", - "locationName":"projectName" - }, - "JobName":{ - "shape":"ModelPackagingJobName", - "documentation":"The job name for the model packaging job.
", - "location":"uri", - "locationName":"jobName" - } - } - }, - "DescribeModelPackagingJobResponse":{ - "type":"structure", - "members":{ - "ModelPackagingDescription":{ - "shape":"ModelPackagingDescription", - "documentation":"The description of the model packaging job.
" - } - } - }, - "DescribeModelRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "ModelVersion" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The project that contains the version of a model that you want to describe.
", - "location":"uri", - "locationName":"projectName" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model that you want to describe.
", - "location":"uri", - "locationName":"modelVersion" - } - } - }, - "DescribeModelResponse":{ - "type":"structure", - "members":{ - "ModelDescription":{ - "shape":"ModelDescription", - "documentation":"Contains the description of the model.
" - } - } - }, - "DescribeProjectRequest":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that you want to describe.
", - "location":"uri", - "locationName":"projectName" - } - } - }, - "DescribeProjectResponse":{ - "type":"structure", - "members":{ - "ProjectDescription":{ - "shape":"ProjectDescription", - "documentation":"The description of the project.
" - } - } - }, - "DetectAnomaliesRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "ModelVersion", - "Body", - "ContentType" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the model version that you want to use.
", - "location":"uri", - "locationName":"projectName" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model that you want to use.
", - "location":"uri", - "locationName":"modelVersion" - }, - "Body":{ - "shape":"Stream", - "documentation":"The unencrypted image bytes that you want to analyze.
" - }, - "ContentType":{ - "shape":"ContentType", - "documentation":"The type of the image passed in Body
. Valid values are image/png
(PNG format images) and image/jpeg
(JPG format images).
The results of the DetectAnomalies
operation.
The source of the image that was analyzed. direct
means that the images was supplied from the local computer. No other values are supported.
True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.
" - }, - "Confidence":{ - "shape":"Float", - "documentation":"The confidence that Lookout for Vision has in the accuracy of the classification in IsAnomalous
.
If the model is an image segmentation model, Anomalies
contains a list of anomaly types found in the image. There is one entry for each type of anomaly found (even if multiple instances of an anomaly type exist on the image). The first element in the list is always an anomaly type representing the image background ('background') and shouldn't be considered an anomaly. Amazon Lookout for Vision automatically add the background anomaly type to the response, and you don't need to declare a background anomaly type in your dataset.
If the list has one entry ('background'), no anomalies were found on the image.
An image classification model doesn't return an Anomalies
list.
If the model is an image segmentation model, AnomalyMask
contains pixel masks that covers all anomaly types found on the image. Each anomaly type has a different mask color. To map a color to an anomaly type, see the color
field of the PixelAnomaly object.
An image classification model doesn't return an Anomalies
list.
The prediction results from a call to DetectAnomalies. DetectAnomalyResult
includes classification information for the prediction (IsAnomalous
and Confidence
). If the model you use is an image segementation model, DetectAnomalyResult
also includes segmentation information (Anomalies
and AnomalyMask
). Classification information is calculated separately from segmentation information and you shouldn't assume a relationship between them.
Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If you specify TargetDevice
, don't specify CompilerOptions
.
For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.
" - }, - "TargetDevice":{ - "shape":"TargetDevice", - "documentation":"The target device for the model. Currently the only supported value is jetson_xavier
. If you specify TargetDevice
, you can't specify TargetPlatform
.
The target platform for the model. If you specify TargetPlatform
, you can't specify TargetDevice
.
An S3 location in which Lookout for Vision stores the component artifacts.
" - }, - "ComponentName":{ - "shape":"ComponentName", - "documentation":"A name for the AWS IoT Greengrass component.
" - }, - "ComponentVersion":{ - "shape":"ComponentVersion", - "documentation":"A Version for the AWS IoT Greengrass component. If you don't provide a value, a default value of Model Version.0.0
is used.
A description for the AWS IoT Greengrass component.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.
" - } - }, - "documentation":"Configuration information for the AWS IoT Greengrass component created in a model packaging job. For more information, see StartModelPackagingJob.
You can't specify a component with the same ComponentName
and Componentversion
as an existing component with the same component name and component version.
The Amazon Resource Name (ARN) of the component.
" - }, - "ComponentName":{ - "shape":"ComponentName", - "documentation":"The name of the component.
" - }, - "ComponentVersion":{ - "shape":"ComponentVersion", - "documentation":"The version of the component.
" - } - }, - "documentation":"Information about the AWS IoT Greengrass component created by a model packaging job.
" - }, - "ImageSource":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"ImageSourceType", - "documentation":"The type of the image.
" - } - }, - "documentation":"The source for an image.
" - }, - "ImageSourceType":{ - "type":"string", - "pattern":"direct" - }, - "InferenceUnits":{ - "type":"integer", - "min":1 - }, - "InputS3Object":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"S3BucketName", - "documentation":"The Amazon S3 bucket that contains the manifest.
" - }, - "Key":{ - "shape":"S3ObjectKey", - "documentation":"The name and location of the manifest file withiin the bucket.
" - }, - "VersionId":{ - "shape":"S3ObjectVersion", - "documentation":"The version ID of the bucket.
" - } - }, - "documentation":"Amazon S3 Location information for an input manifest file.
" - }, - "Integer":{"type":"integer"}, - "InternalServerException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"ExceptionString"}, - "RetryAfterSeconds":{ - "shape":"RetryAfterSeconds", - "documentation":"The period of time, in seconds, before the operation can be retried.
", - "location":"header", - "locationName":"Retry-After" - } - }, - "documentation":"Amazon Lookout for Vision experienced a service issue. Try your call again.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "IsLabeled":{"type":"boolean"}, - "KmsKeyId":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" - }, - "ListDatasetEntriesRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "DatasetType" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the dataset that you want to list.
", - "location":"uri", - "locationName":"projectName" - }, - "DatasetType":{ - "shape":"DatasetType", - "documentation":"The type of the dataset that you want to list. Specify train
to list the training dataset. Specify test
to list the test dataset. If you have a single dataset project, specify train
.
Specify true
to include labeled entries, otherwise specify false
. If you don't specify a value, Lookout for Vision returns all entries.
Specify normal
to include only normal images. Specify anomaly
to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.
Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00
.
Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00
.
If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.
", - "location":"querystring", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"PageSize", - "documentation":"The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
", - "location":"querystring", - "locationName":"maxResults" - }, - "SourceRefContains":{ - "shape":"QueryString", - "documentation":"Perform a \"contains\" search on the values of the source-ref
key within the dataset. For example a value of \"IMG_17\" returns all JSON Lines where the source-ref
key value matches *IMG_17*.
A list of the entries (JSON Lines) within the dataset.
" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.
" - } - } - }, - "ListModelPackagingJobsRequest":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project for which you want to list the model packaging jobs.
", - "location":"uri", - "locationName":"projectName" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"PageSize", - "documentation":"The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListModelPackagingJobsResponse":{ - "type":"structure", - "members":{ - "ModelPackagingJobs":{ - "shape":"ModelPackagingJobsList", - "documentation":"A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.
" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" - } - } - }, - "ListModelsRequest":{ - "type":"structure", - "required":["ProjectName"], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the model versions that you want to list.
", - "location":"uri", - "locationName":"projectName" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of models.
", - "location":"querystring", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"PageSize", - "documentation":"The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListModelsResponse":{ - "type":"structure", - "members":{ - "Models":{ - "shape":"ModelMetadataList", - "documentation":"A list of model versions in the specified project.
" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of models.
" - } - } - }, - "ListProjectsRequest":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.
", - "location":"querystring", - "locationName":"nextToken" - }, - "MaxResults":{ - "shape":"PageSize", - "documentation":"The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListProjectsResponse":{ - "type":"structure", - "members":{ - "Projects":{ - "shape":"ProjectMetadataList", - "documentation":"A list of projects in your AWS account.
" - }, - "NextToken":{ - "shape":"PaginationToken", - "documentation":"If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.
" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"TagArn", - "documentation":"The Amazon Resource Name (ARN) of the model for which you want to list tags.
", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagList", - "documentation":"A map of tag keys and values attached to the specified model.
" - } - } - }, - "ModelArn":{"type":"string"}, - "ModelDescription":{ - "type":"structure", - "members":{ - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model
" - }, - "ModelArn":{ - "shape":"ModelArn", - "documentation":"The Amazon Resource Name (ARN) of the model.
" - }, - "CreationTimestamp":{ - "shape":"DateTime", - "documentation":"The unix timestamp for the date and time that the model was created.
" - }, - "Description":{ - "shape":"ModelDescriptionMessage", - "documentation":"The description for the model.
" - }, - "Status":{ - "shape":"ModelStatus", - "documentation":"The status of the model.
" - }, - "StatusMessage":{ - "shape":"ModelStatusMessage", - "documentation":"The status message for the model.
" - }, - "Performance":{ - "shape":"ModelPerformance", - "documentation":"Performance metrics for the model. Created during training.
" - }, - "OutputConfig":{ - "shape":"OutputConfig", - "documentation":"The S3 location where Amazon Lookout for Vision saves model training files.
" - }, - "EvaluationManifest":{ - "shape":"OutputS3Object", - "documentation":"The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.
" - }, - "EvaluationResult":{ - "shape":"OutputS3Object", - "documentation":"The S3 location where Amazon Lookout for Vision saves the performance metrics.
" - }, - "EvaluationEndTimestamp":{ - "shape":"DateTime", - "documentation":"The unix timestamp for the date and time that the evaluation ended.
" - }, - "KmsKeyId":{ - "shape":"KmsKeyId", - "documentation":"The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
" - }, - "MinInferenceUnits":{ - "shape":"InferenceUnits", - "documentation":"The minimum number of inference units used by the model. For more information, see StartModel
" - }, - "MaxInferenceUnits":{ - "shape":"InferenceUnits", - "documentation":"The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.
" - } - }, - "documentation":"Describes an Amazon Lookout for Vision model.
" - }, - "ModelDescriptionMessage":{ - "type":"string", - "max":500, - "min":1, - "pattern":"[0-9A-Za-z\\.\\-_]*" - }, - "ModelHostingStatus":{ - "type":"string", - "enum":[ - "STARTING_HOSTING", - "HOSTED", - "HOSTING_FAILED", - "STOPPING_HOSTING", - "SYSTEM_UPDATING" - ] - }, - "ModelMetadata":{ - "type":"structure", - "members":{ - "CreationTimestamp":{ - "shape":"DateTime", - "documentation":"The unix timestamp for the date and time that the model was created.
" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model.
" - }, - "ModelArn":{ - "shape":"ModelArn", - "documentation":"The Amazon Resource Name (ARN) of the model.
" - }, - "Description":{ - "shape":"ModelDescriptionMessage", - "documentation":"The description for the model.
" - }, - "Status":{ - "shape":"ModelStatus", - "documentation":"The status of the model.
" - }, - "StatusMessage":{ - "shape":"ModelStatusMessage", - "documentation":"The status message for the model.
" - }, - "Performance":{ - "shape":"ModelPerformance", - "documentation":"Performance metrics for the model. Not available until training has successfully completed.
" - } - }, - "documentation":"Describes an Amazon Lookout for Vision model.
" - }, - "ModelMetadataList":{ - "type":"list", - "member":{"shape":"ModelMetadata"} - }, - "ModelPackagingConfiguration":{ - "type":"structure", - "required":["Greengrass"], - "members":{ - "Greengrass":{ - "shape":"GreengrassConfiguration", - "documentation":"Configuration information for the AWS IoT Greengrass component in a model packaging job.
" - } - }, - "documentation":"Configuration information for a Amazon Lookout for Vision model packaging job. For more information, see StartModelPackagingJob.
" - }, - "ModelPackagingDescription":{ - "type":"structure", - "members":{ - "JobName":{ - "shape":"ModelPackagingJobName", - "documentation":"The name of the model packaging job.
" - }, - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that's associated with a model that's in the model package.
" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model used in the model packaging job.
" - }, - "ModelPackagingConfiguration":{ - "shape":"ModelPackagingConfiguration", - "documentation":"The configuration information used in the model packaging job.
" - }, - "ModelPackagingJobDescription":{ - "shape":"ModelPackagingJobDescription", - "documentation":"The description for the model packaging job.
" - }, - "ModelPackagingMethod":{ - "shape":"ModelPackagingMethod", - "documentation":"The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.
" - }, - "ModelPackagingOutputDetails":{ - "shape":"ModelPackagingOutputDetails", - "documentation":"Information about the output of the model packaging job. For more information, see DescribeModelPackagingJob.
" - }, - "Status":{ - "shape":"ModelPackagingJobStatus", - "documentation":"The status of the model packaging job.
" - }, - "StatusMessage":{ - "shape":"ModelPackagingStatusMessage", - "documentation":"The status message for the model packaging job.
" - }, - "CreationTimestamp":{ - "shape":"DateTime", - "documentation":"The Unix timestamp for the time and date that the model packaging job was created.
" - }, - "LastUpdatedTimestamp":{ - "shape":"DateTime", - "documentation":"The Unix timestamp for the time and date that the model packaging job was last updated.
" - } - }, - "documentation":"Information about a model packaging job. For more information, see DescribeModelPackagingJob.
" - }, - "ModelPackagingJobDescription":{ - "type":"string", - "max":256, - "min":1, - "pattern":"[a-zA-Z0-9-_. ()':,;?]+" - }, - "ModelPackagingJobMetadata":{ - "type":"structure", - "members":{ - "JobName":{ - "shape":"ModelPackagingJobName", - "documentation":"The name of the model packaging job.
" - }, - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The project that contains the model that is in the model package.
" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model that is in the model package.
" - }, - "ModelPackagingJobDescription":{ - "shape":"ModelPackagingJobDescription", - "documentation":"The description for the model packaging job.
" - }, - "ModelPackagingMethod":{ - "shape":"ModelPackagingMethod", - "documentation":"The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.
" - }, - "Status":{ - "shape":"ModelPackagingJobStatus", - "documentation":"The status of the model packaging job.
" - }, - "StatusMessage":{ - "shape":"ModelPackagingStatusMessage", - "documentation":"The status message for the model packaging job.
" - }, - "CreationTimestamp":{ - "shape":"DateTime", - "documentation":"The Unix timestamp for the time and date that the model packaging job was created.
" - }, - "LastUpdatedTimestamp":{ - "shape":"DateTime", - "documentation":"The Unix timestamp for the time and date that the model packaging job was last updated.
" - } - }, - "documentation":"Metadata for a model packaging job. For more information, see ListModelPackagingJobs.
" - }, - "ModelPackagingJobName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9-]+" - }, - "ModelPackagingJobStatus":{ - "type":"string", - "enum":[ - "CREATED", - "RUNNING", - "SUCCEEDED", - "FAILED" - ] - }, - "ModelPackagingJobsList":{ - "type":"list", - "member":{"shape":"ModelPackagingJobMetadata"} - }, - "ModelPackagingMethod":{ - "type":"string", - "max":32, - "min":1, - "pattern":"^[a-zA-Z0-9]+" - }, - "ModelPackagingOutputDetails":{ - "type":"structure", - "members":{ - "Greengrass":{ - "shape":"GreengrassOutputDetails", - "documentation":"Information about the AWS IoT Greengrass component in a model packaging job.
" - } - }, - "documentation":"Information about the output from a model packaging job.
" - }, - "ModelPackagingStatusMessage":{"type":"string"}, - "ModelPerformance":{ - "type":"structure", - "members":{ - "F1Score":{ - "shape":"Float", - "documentation":"The overall F1 score metric for the trained model.
" - }, - "Recall":{ - "shape":"Float", - "documentation":"The overall recall metric value for the trained model.
" - }, - "Precision":{ - "shape":"Float", - "documentation":"The overall precision metric value for the trained model.
" - } - }, - "documentation":"Information about the evaluation performance of a trained model.
" - }, - "ModelStatus":{ - "type":"string", - "enum":[ - "TRAINING", - "TRAINED", - "TRAINING_FAILED", - "STARTING_HOSTING", - "HOSTED", - "HOSTING_FAILED", - "STOPPING_HOSTING", - "SYSTEM_UPDATING", - "DELETING" - ] - }, - "ModelStatusMessage":{"type":"string"}, - "ModelVersion":{ - "type":"string", - "max":10, - "min":1, - "pattern":"([1-9][0-9]*|latest)" - }, - "ModelVersionNoLatest":{ - "type":"string", - "max":10, - "min":1, - "pattern":"([1-9][0-9]*)" - }, - "OutputConfig":{ - "type":"structure", - "required":["S3Location"], - "members":{ - "S3Location":{ - "shape":"S3Location", - "documentation":"The S3 location for the output.
" - } - }, - "documentation":"The S3 location where Amazon Lookout for Vision saves model training files.
" - }, - "OutputS3Object":{ - "type":"structure", - "required":[ - "Bucket", - "Key" - ], - "members":{ - "Bucket":{ - "shape":"S3BucketName", - "documentation":"The bucket that contains the training output.
" - }, - "Key":{ - "shape":"S3ObjectKey", - "documentation":"The location of the training output in the bucket.
" - } - }, - "documentation":"The S3 location where Amazon Lookout for Vision saves training output.
" - }, - "PageSize":{ - "type":"integer", - "max":100, - "min":1 - }, - "PaginationToken":{ - "type":"string", - "max":2048, - "pattern":"^[a-zA-Z0-9\\/\\+\\=]{0,2048}$" - }, - "PixelAnomaly":{ - "type":"structure", - "members":{ - "TotalPercentageArea":{ - "shape":"Float", - "documentation":"The percentage area of the image that the anomaly type covers.
" - }, - "Color":{ - "shape":"Color", - "documentation":"A hex color value for the mask that covers an anomaly type. Each anomaly type has a different mask color. The color maps to the color of the anomaly type used in the training dataset.
" - } - }, - "documentation":"Information about the pixels in an anomaly mask. For more information, see Anomaly. PixelAnomaly
is only returned by image segmentation models.
The Amazon Resource Name (ARN) of the project.
" - }, - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project.
" - }, - "CreationTimestamp":{ - "shape":"DateTime", - "documentation":"The unix timestamp for the date and time that the project was created.
" - }, - "Datasets":{ - "shape":"DatasetMetadataList", - "documentation":"A list of datasets in the project.
" - } - }, - "documentation":"Describe an Amazon Lookout for Vision project. For more information, see DescribeProject.
" - }, - "ProjectMetadata":{ - "type":"structure", - "members":{ - "ProjectArn":{ - "shape":"ProjectArn", - "documentation":"The Amazon Resource Name (ARN) of the project.
" - }, - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project.
" - }, - "CreationTimestamp":{ - "shape":"DateTime", - "documentation":"The unix timestamp for the date and time that the project was created.
" - } - }, - "documentation":"Metadata about an Amazon Lookout for Vision project.
" - }, - "ProjectMetadataList":{ - "type":"list", - "member":{"shape":"ProjectMetadata"} - }, - "ProjectName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[a-zA-Z0-9][a-zA-Z0-9_\\-]*" - }, - "QueryString":{ - "type":"string", - "max":2048, - "min":1, - "pattern":".*\\S.*" - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":[ - "Message", - "ResourceId", - "ResourceType" - ], - "members":{ - "Message":{"shape":"ExceptionString"}, - "ResourceId":{ - "shape":"ExceptionString", - "documentation":"The ID of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of the resource.
" - } - }, - "documentation":"The resource could not be found.
", - "error":{"httpStatusCode":404}, - "exception":true - }, - "ResourceType":{ - "type":"string", - "enum":[ - "PROJECT", - "DATASET", - "MODEL", - "TRIAL", - "MODEL_PACKAGE_JOB" - ] - }, - "RetryAfterSeconds":{"type":"integer"}, - "S3BucketName":{ - "type":"string", - "max":63, - "min":3, - "pattern":"[0-9A-Za-z\\.\\-_]*" - }, - "S3KeyPrefix":{ - "type":"string", - "max":1024, - "pattern":"^([a-zA-Z0-9!_.*'()-][/a-zA-Z0-9!_.*'()-]*)?$" - }, - "S3Location":{ - "type":"structure", - "required":["Bucket"], - "members":{ - "Bucket":{ - "shape":"S3BucketName", - "documentation":"The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.
" - }, - "Prefix":{ - "shape":"S3KeyPrefix", - "documentation":"The path of the folder, within the S3 bucket, that contains the output.
" - } - }, - "documentation":"Information about the location of training output or the output of a model packaging job.
" - }, - "S3ObjectKey":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"^([a-zA-Z0-9!_.*'()-][/a-zA-Z0-9!_.*'()-]*)?$" - }, - "S3ObjectVersion":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*" - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":[ - "Message", - "QuotaCode", - "ServiceCode" - ], - "members":{ - "Message":{"shape":"ExceptionString"}, - "ResourceId":{ - "shape":"ExceptionString", - "documentation":"The ID of the resource.
" - }, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of the resource.
" - }, - "QuotaCode":{ - "shape":"ExceptionString", - "documentation":"The quota code.
" - }, - "ServiceCode":{ - "shape":"ExceptionString", - "documentation":"The service code.
" - } - }, - "documentation":"A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.
", - "error":{"httpStatusCode":402}, - "exception":true - }, - "StartModelPackagingJobRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "ModelVersion", - "Configuration" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project which contains the version of the model that you want to package.
", - "location":"uri", - "locationName":"projectName" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model within the project that you want to package.
" - }, - "JobName":{ - "shape":"ModelPackagingJobName", - "documentation":"A name for the model packaging job. If you don't supply a value, the service creates a job name for you.
" - }, - "Configuration":{ - "shape":"ModelPackagingConfiguration", - "documentation":"The configuration for the model packaging job.
" - }, - "Description":{ - "shape":"ModelPackagingJobDescription", - "documentation":"A description for the model packaging job.
" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to StartModelPackagingJob
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModelPackagingJob
. In this case, safely retry your call to StartModelPackagingJob
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset creation requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to StartModelPackagingJob
. An idempotency token is active for 8 hours.
The job name for the model packaging job. If you don't supply a job name in the JobName
input parameter, the service creates a job name for you.
The name of the project that contains the model that you want to start.
", - "location":"uri", - "locationName":"projectName" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model that you want to start.
", - "location":"uri", - "locationName":"modelVersion" - }, - "MinInferenceUnits":{ - "shape":"InferenceUnits", - "documentation":"The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.
" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to StartModel
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModel
. In this case, safely retry your call to StartModel
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple start requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to StartModel
. An idempotency token is active for 8 hours.
The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the model.
" - } - } - }, - "StartModelResponse":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"ModelHostingStatus", - "documentation":"The current running status of the model.
" - } - } - }, - "StopModelRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "ModelVersion" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the model that you want to stop.
", - "location":"uri", - "locationName":"projectName" - }, - "ModelVersion":{ - "shape":"ModelVersion", - "documentation":"The version of the model that you want to stop.
", - "location":"uri", - "locationName":"modelVersion" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to StopModel
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StopModel
. In this case, safely retry your call to StopModel
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple stop requests. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to StopModel
. An idempotency token is active for 8 hours.
The status of the model.
" - } - } - }, - "Stream":{ - "type":"blob", - "requiresLength":true, - "streaming":true - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"The key of the tag that is attached to the specified model.
" - }, - "Value":{ - "shape":"TagValue", - "documentation":"The value of the tag that is attached to the specified model.
" - } - }, - "documentation":"A key and value pair that is attached to the specified Amazon Lookout for Vision model.
" - }, - "TagArn":{ - "type":"string", - "max":1011, - "min":1 - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":200, - "min":0 - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "max":200, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{ - "shape":"TagArn", - "documentation":"The Amazon Resource Name (ARN) of the model to assign the tags.
", - "location":"uri", - "locationName":"resourceArn" - }, - "Tags":{ - "shape":"TagList", - "documentation":"The key-value tags to assign to the model.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - }, - "TargetDevice":{ - "type":"string", - "enum":["jetson_xavier"] - }, - "TargetPlatform":{ - "type":"structure", - "required":[ - "Os", - "Arch" - ], - "members":{ - "Os":{ - "shape":"TargetPlatformOs", - "documentation":"The target operating system for the model. Linux is the only operating system that is currently supported.
" - }, - "Arch":{ - "shape":"TargetPlatformArch", - "documentation":"The target architecture for the model. The currently supported architectures are X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).
" - }, - "Accelerator":{ - "shape":"TargetPlatformAccelerator", - "documentation":"The target accelerator for the model. Currently, Amazon Lookout for Vision only supports NVIDIA (Nvidia graphics processing unit) and CPU accelerators. If you specify NVIDIA as an accelerator, you must also specify the gpu-code
, trt-ver
, and cuda-ver
compiler options. If you don't specify an accelerator, Lookout for Vision uses the CPU for compilation and we highly recommend that you use the GreengrassConfiguration$CompilerOptions field. For example, you can use the following compiler options for CPU:
mcpu
: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
mattr
: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
The platform on which a model runs on an AWS IoT Greengrass core device.
" - }, - "TargetPlatformAccelerator":{ - "type":"string", - "enum":["NVIDIA"] - }, - "TargetPlatformArch":{ - "type":"string", - "enum":[ - "ARM64", - "X86_64" - ] - }, - "TargetPlatformOs":{ - "type":"string", - "enum":["LINUX"] - }, - "ThrottlingException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"ExceptionString"}, - "QuotaCode":{ - "shape":"ExceptionString", - "documentation":"The quota code.
" - }, - "ServiceCode":{ - "shape":"ExceptionString", - "documentation":"The service code.
" - }, - "RetryAfterSeconds":{ - "shape":"RetryAfterSeconds", - "documentation":"The period of time, in seconds, before the operation can be retried.
", - "location":"header", - "locationName":"Retry-After" - } - }, - "documentation":"Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.
", - "error":{"httpStatusCode":429}, - "exception":true - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{ - "shape":"TagArn", - "documentation":"The Amazon Resource Name (ARN) of the model from which you want to remove tags.
", - "location":"uri", - "locationName":"resourceArn" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"A list of the keys of the tags that you want to remove.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateDatasetEntriesRequest":{ - "type":"structure", - "required":[ - "ProjectName", - "DatasetType", - "Changes" - ], - "members":{ - "ProjectName":{ - "shape":"ProjectName", - "documentation":"The name of the project that contains the dataset that you want to update.
", - "location":"uri", - "locationName":"projectName" - }, - "DatasetType":{ - "shape":"DatasetType", - "documentation":"The type of the dataset that you want to update. Specify train
to update the training dataset. Specify test
to update the test dataset. If you have a single dataset project, specify train
.
The entries to add to the dataset.
" - }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from UpdateDatasetEntries
. In this case, safely retry your call to UpdateDatasetEntries
by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken
, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple updates with the same dataset entries. You'll need to provide your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken
is considered a new call to UpdateDatasetEntries
. An idempotency token is active for 8 hours.
The status of the dataset update.
" - } - } - }, - "ValidationException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"ExceptionString"} - }, - "documentation":"An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.
", - "error":{"httpStatusCode":400}, - "exception":true - } - }, - "documentation":"This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, data types, common parameters, and common errors.
Amazon Lookout for Vision enables you to find visual defects in industrial products, accurately and at scale. It uses computer vision to identify missing components in an industrial product, damage to vehicles or structures, irregularities in production lines, and even minuscule defects in silicon wafers — or any other physical item where quality is important such as a missing capacitor on printed circuit boards.
" -} diff --git a/awscli/botocore/data/qldb/2019-01-02/endpoint-rule-set-1.json b/awscli/botocore/data/qldb/2019-01-02/endpoint-rule-set-1.json deleted file mode 100644 index 8368f18b0761..000000000000 --- a/awscli/botocore/data/qldb/2019-01-02/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://qldb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://qldb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://qldb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://qldb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/qldb/2019-01-02/paginators-1.json b/awscli/botocore/data/qldb/2019-01-02/paginators-1.json deleted file mode 100644 index ea142457a6a7..000000000000 --- a/awscli/botocore/data/qldb/2019-01-02/paginators-1.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "pagination": {} -} diff --git a/awscli/botocore/data/qldb/2019-01-02/service-2.json b/awscli/botocore/data/qldb/2019-01-02/service-2.json deleted file mode 100644 index ec41b2555c8c..000000000000 --- a/awscli/botocore/data/qldb/2019-01-02/service-2.json +++ /dev/null @@ -1,1476 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2019-01-02", - "endpointPrefix":"qldb", - "jsonVersion":"1.0", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceAbbreviation":"QLDB", - "serviceFullName":"Amazon QLDB", - "serviceId":"QLDB", - "signatureVersion":"v4", - "signingName":"qldb", - "uid":"qldb-2019-01-02", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "CancelJournalKinesisStream":{ - "name":"CancelJournalKinesisStream", - "http":{ - "method":"DELETE", - "requestUri":"/ledgers/{name}/journal-kinesis-streams/{streamId}" - }, - "input":{"shape":"CancelJournalKinesisStreamRequest"}, - "output":{"shape":"CancelJournalKinesisStreamResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourcePreconditionNotMetException"} - ], - "documentation":"Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE
.
You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
" - }, - "CreateLedger":{ - "name":"CreateLedger", - "http":{ - "method":"POST", - "requestUri":"/ledgers" - }, - "input":{"shape":"CreateLedgerRequest"}, - "output":{"shape":"CreateLedgerResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ResourceInUseException"} - ], - "documentation":"Creates a new ledger in your Amazon Web Services account in the current Region.
" - }, - "DeleteLedger":{ - "name":"DeleteLedger", - "http":{ - "method":"DELETE", - "requestUri":"/ledgers/{name}" - }, - "input":{"shape":"DeleteLedgerRequest"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourcePreconditionNotMetException"} - ], - "documentation":"Deletes a ledger and all of its contents. This action is irreversible.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger
operation to set this parameter to false
.
Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
" - }, - "DescribeJournalS3Export":{ - "name":"DescribeJournalS3Export", - "http":{ - "method":"GET", - "requestUri":"/ledgers/{name}/journal-s3-exports/{exportId}" - }, - "input":{"shape":"DescribeJournalS3ExportRequest"}, - "output":{"shape":"DescribeJournalS3ExportResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
If the export job with the given ExportId
doesn't exist, then throws ResourceNotFoundException
.
If the ledger with the given Name
doesn't exist, then throws ResourceNotFoundException
.
Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.
" - }, - "ExportJournalToS3":{ - "name":"ExportJournalToS3", - "http":{ - "method":"POST", - "requestUri":"/ledgers/{name}/journal-s3-exports" - }, - "input":{"shape":"ExportJournalToS3Request"}, - "output":{"shape":"ExportJournalToS3Response"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourcePreconditionNotMetException"} - ], - "documentation":"Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.
If the ledger with the given Name
doesn't exist, then throws ResourceNotFoundException
.
If the ledger with the given Name
is in CREATING
status, then throws ResourcePreconditionNotMetException
.
You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException
.
Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress
is provided.
For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.
If the specified ledger doesn't exist or is in DELETING
status, then throws ResourceNotFoundException
.
If the specified ledger is in CREATING
status, then throws ResourcePreconditionNotMetException
.
If no block exists with the specified address, then throws InvalidParameterException
.
Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.
" - }, - "GetRevision":{ - "name":"GetRevision", - "http":{ - "method":"POST", - "requestUri":"/ledgers/{name}/revision" - }, - "input":{"shape":"GetRevisionRequest"}, - "output":{"shape":"GetRevisionResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourcePreconditionNotMetException"} - ], - "documentation":"Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress
is provided.
Returns all Amazon QLDB journal streams for a given ledger.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
This action returns a maximum of MaxResults
items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger
multiple times.
Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of MaxResults
items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports
multiple times.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
" - }, - "ListJournalS3ExportsForLedger":{ - "name":"ListJournalS3ExportsForLedger", - "http":{ - "method":"GET", - "requestUri":"/ledgers/{name}/journal-s3-exports" - }, - "input":{"shape":"ListJournalS3ExportsForLedgerRequest"}, - "output":{"shape":"ListJournalS3ExportsForLedgerResponse"}, - "documentation":"Returns all journal export jobs for a specified ledger.
This action returns a maximum of MaxResults
items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger
multiple times.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer Guide.
" - }, - "ListLedgers":{ - "name":"ListLedgers", - "http":{ - "method":"GET", - "requestUri":"/ledgers" - }, - "input":{"shape":"ListLedgersRequest"}, - "output":{"shape":"ListLedgersResponse"}, - "documentation":"Returns all ledgers that are associated with the current Amazon Web Services account and Region.
This action returns a maximum of MaxResults
items and is paginated so that you can retrieve all the items by calling ListLedgers
multiple times.
Returns all tags for a specified Amazon QLDB resource.
" - }, - "StreamJournalToKinesis":{ - "name":"StreamJournalToKinesis", - "http":{ - "method":"POST", - "requestUri":"/ledgers/{name}/journal-kinesis-streams" - }, - "input":{"shape":"StreamJournalToKinesisRequest"}, - "output":{"shape":"StreamJournalToKinesisResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourcePreconditionNotMetException"} - ], - "documentation":"Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Adds one or more tags to a specified Amazon QLDB resource.
A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
" - }, - "UpdateLedger":{ - "name":"UpdateLedger", - "http":{ - "method":"PATCH", - "requestUri":"/ledgers/{name}" - }, - "input":{"shape":"UpdateLedgerRequest"}, - "output":{"shape":"UpdateLedgerResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Updates properties on a ledger.
" - }, - "UpdateLedgerPermissionsMode":{ - "name":"UpdateLedgerPermissionsMode", - "http":{ - "method":"PATCH", - "requestUri":"/ledgers/{name}/permissions-mode" - }, - "input":{"shape":"UpdateLedgerPermissionsModeRequest"}, - "output":{"shape":"UpdateLedgerPermissionsModeResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Updates the permissions mode of a ledger.
Before you switch to the STANDARD
permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.
The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "StreamId":{ - "shape":"UniqueId", - "documentation":"The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled.
", - "location":"uri", - "locationName":"streamId" - } - } - }, - "CancelJournalKinesisStreamResponse":{ - "type":"structure", - "members":{ - "StreamId":{ - "shape":"UniqueId", - "documentation":"The UUID (Base62-encoded text) of the canceled QLDB journal stream.
" - } - } - }, - "CreateLedgerRequest":{ - "type":"structure", - "required":[ - "Name", - "PermissionsMode" - ], - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger that you want to create. The name must be unique among all of the ledgers in your Amazon Web Services account in the current Region.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
" - }, - "Tags":{ - "shape":"Tags", - "documentation":"The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.
" - }, - "PermissionsMode":{ - "shape":"PermissionsMode", - "documentation":"The permissions mode to assign to the ledger that you want to create. This parameter can have one of the following values:
ALLOW_ALL
: A legacy permissions mode that enables access control with API-level granularity for ledgers.
This mode allows users who have the SendCommand
API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL
) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.
STANDARD
: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.
By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the SendCommand
API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide.
We strongly recommend using the STANDARD
permissions mode to maximize the security of your ledger data.
Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true
) by default.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger
operation to set this parameter to false
.
The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer Guide.
Use one of the following options to specify this parameter:
AWS_OWNED_KMS_KEY
: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.
Undefined: By default, use an Amazon Web Services owned KMS key.
A valid symmetric customer managed KMS key: Use the specified symmetric encryption KMS key in your account that you create, own, and manage.
Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
" - } - } - }, - "CreateLedgerResponse":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
" - }, - "Arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) for the ledger.
" - }, - "State":{ - "shape":"LedgerState", - "documentation":"The current status of the ledger.
" - }, - "CreationDateTime":{ - "shape":"Timestamp", - "documentation":"The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
" - }, - "PermissionsMode":{ - "shape":"PermissionsMode", - "documentation":"The permissions mode of the ledger that you created.
" - }, - "DeletionProtection":{ - "shape":"DeletionProtection", - "documentation":"Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true
) by default.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger
operation to set this parameter to false
.
The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.
" - } - } - }, - "DeleteLedgerRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger that you want to delete.
", - "location":"uri", - "locationName":"name" - } - } - }, - "DeletionProtection":{"type":"boolean"}, - "DescribeJournalKinesisStreamRequest":{ - "type":"structure", - "required":[ - "LedgerName", - "StreamId" - ], - "members":{ - "LedgerName":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "StreamId":{ - "shape":"UniqueId", - "documentation":"The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.
", - "location":"uri", - "locationName":"streamId" - } - } - }, - "DescribeJournalKinesisStreamResponse":{ - "type":"structure", - "members":{ - "Stream":{ - "shape":"JournalKinesisStreamDescription", - "documentation":"Information about the QLDB journal stream returned by a DescribeJournalS3Export
request.
The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "ExportId":{ - "shape":"UniqueId", - "documentation":"The UUID (represented in Base62-encoded text) of the journal export job to describe.
", - "location":"uri", - "locationName":"exportId" - } - } - }, - "DescribeJournalS3ExportResponse":{ - "type":"structure", - "required":["ExportDescription"], - "members":{ - "ExportDescription":{ - "shape":"JournalS3ExportDescription", - "documentation":"Information about the journal export job returned by a DescribeJournalS3Export
request.
The name of the ledger that you want to describe.
", - "location":"uri", - "locationName":"name" - } - } - }, - "DescribeLedgerResponse":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
" - }, - "Arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) for the ledger.
" - }, - "State":{ - "shape":"LedgerState", - "documentation":"The current status of the ledger.
" - }, - "CreationDateTime":{ - "shape":"Timestamp", - "documentation":"The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
" - }, - "PermissionsMode":{ - "shape":"PermissionsMode", - "documentation":"The permissions mode of the ledger.
" - }, - "DeletionProtection":{ - "shape":"DeletionProtection", - "documentation":"Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true
) by default.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger
operation to set this parameter to false
.
Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.
" - } - } - }, - "Digest":{ - "type":"blob", - "max":32, - "min":32 - }, - "EncryptionStatus":{ - "type":"string", - "enum":[ - "ENABLED", - "UPDATING", - "KMS_KEY_INACCESSIBLE" - ] - }, - "ErrorCause":{ - "type":"string", - "enum":[ - "KINESIS_STREAM_NOT_FOUND", - "IAM_PERMISSION_REVOKED" - ] - }, - "ErrorMessage":{"type":"string"}, - "ExportJournalToS3Request":{ - "type":"structure", - "required":[ - "Name", - "InclusiveStartTime", - "ExclusiveEndTime", - "S3ExportConfiguration", - "RoleArn" - ], - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "InclusiveStartTime":{ - "shape":"Timestamp", - "documentation":"The inclusive start date and time for the range of journal contents to export.
The InclusiveStartTime
must be in ISO 8601
date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
The InclusiveStartTime
must be before ExclusiveEndTime
.
If you provide an InclusiveStartTime
that is before the ledger's CreationDateTime
, Amazon QLDB defaults it to the ledger's CreationDateTime
.
The exclusive end date and time for the range of journal contents to export.
The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
The ExclusiveEndTime
must be less than or equal to the current UTC date and time.
The configuration settings of the Amazon S3 bucket destination for your export request.
" - }, - "RoleArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:
Write objects into your Amazon S3 bucket.
(Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.
To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole
action on the IAM role resource. This is required for all journal export requests.
The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.
Default: ION_TEXT
In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.
" - } - } - }, - "ExportJournalToS3Response":{ - "type":"structure", - "required":["ExportId"], - "members":{ - "ExportId":{ - "shape":"UniqueId", - "documentation":"The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export job.
To describe your export request and check the status of the job, you can use ExportId
to call DescribeJournalS3Export
.
The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "BlockAddress":{ - "shape":"ValueHolder", - "documentation":"The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: strandId
and sequenceNo
.
For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}
.
The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId
and sequenceNo
.
For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}
.
The block data object in Amazon Ion format.
" - }, - "Proof":{ - "shape":"ValueHolder", - "documentation":"The proof object in Amazon Ion format returned by a GetBlock
request. A proof contains the list of hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block.
The name of the ledger.
", - "location":"uri", - "locationName":"name" - } - } - }, - "GetDigestResponse":{ - "type":"structure", - "required":[ - "Digest", - "DigestTipAddress" - ], - "members":{ - "Digest":{ - "shape":"Digest", - "documentation":"The 256-bit hash value representing the digest returned by a GetDigest
request.
The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId
and sequenceNo
.
The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "BlockAddress":{ - "shape":"ValueHolder", - "documentation":"The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId
and sequenceNo
.
For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}
.
The UUID (represented in Base62-encoded text) of the document to be verified.
" - }, - "DigestTipAddress":{ - "shape":"ValueHolder", - "documentation":"The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId
and sequenceNo
.
For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}
.
The proof object in Amazon Ion format returned by a GetRevision
request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.
The document revision data object in Amazon Ion format.
" - } - } - }, - "InvalidParameterException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"}, - "ParameterName":{ - "shape":"ParameterName", - "documentation":"The name of the invalid parameter.
" - } - }, - "documentation":"One or more parameters in the request aren't valid.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "IonText":{ - "type":"string", - "max":1048576, - "min":1, - "sensitive":true - }, - "JournalKinesisStreamDescription":{ - "type":"structure", - "required":[ - "LedgerName", - "RoleArn", - "StreamId", - "Status", - "KinesisConfiguration", - "StreamName" - ], - "members":{ - "LedgerName":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
" - }, - "InclusiveStartTime":{ - "shape":"Timestamp", - "documentation":"The inclusive start date and time from which to start streaming journal data.
" - }, - "ExclusiveEndTime":{ - "shape":"Timestamp", - "documentation":"The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.
" - }, - "RoleArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
" - }, - "StreamId":{ - "shape":"UniqueId", - "documentation":"The UUID (represented in Base62-encoded text) of the QLDB journal stream.
" - }, - "Arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the QLDB journal stream.
" - }, - "Status":{ - "shape":"StreamStatus", - "documentation":"The current state of the QLDB journal stream.
" - }, - "KinesisConfiguration":{ - "shape":"KinesisConfiguration", - "documentation":"The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
" - }, - "ErrorCause":{ - "shape":"ErrorCause", - "documentation":"The error message that describes the reason that a stream has a status of IMPAIRED
or FAILED
. This is not applicable to streams that have other status values.
The user-defined name of the QLDB journal stream.
" - } - }, - "documentation":"Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.
" - }, - "JournalKinesisStreamDescriptionList":{ - "type":"list", - "member":{"shape":"JournalKinesisStreamDescription"} - }, - "JournalS3ExportDescription":{ - "type":"structure", - "required":[ - "LedgerName", - "ExportId", - "ExportCreationTime", - "Status", - "InclusiveStartTime", - "ExclusiveEndTime", - "S3ExportConfiguration", - "RoleArn" - ], - "members":{ - "LedgerName":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
" - }, - "ExportId":{ - "shape":"UniqueId", - "documentation":"The UUID (represented in Base62-encoded text) of the journal export job.
" - }, - "ExportCreationTime":{ - "shape":"Timestamp", - "documentation":"The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
" - }, - "Status":{ - "shape":"ExportStatus", - "documentation":"The current state of the journal export job.
" - }, - "InclusiveStartTime":{ - "shape":"Timestamp", - "documentation":"The inclusive start date and time for the range of journal contents that was specified in the original export request.
" - }, - "ExclusiveEndTime":{ - "shape":"Timestamp", - "documentation":"The exclusive end date and time for the range of journal contents that was specified in the original export request.
" - }, - "S3ExportConfiguration":{"shape":"S3ExportConfiguration"}, - "RoleArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:
Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.
(Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.
The output format of the exported journal data.
" - } - }, - "documentation":"Information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.
" - }, - "JournalS3ExportList":{ - "type":"list", - "member":{"shape":"JournalS3ExportDescription"} - }, - "KinesisConfiguration":{ - "type":"structure", - "required":["StreamArn"], - "members":{ - "StreamArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
" - }, - "AggregationEnabled":{ - "shape":"Boolean", - "documentation":"Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.
Default: True
Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide.
The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.
" - }, - "KmsKey":{ - "type":"string", - "max":1600 - }, - "LedgerEncryptionDescription":{ - "type":"structure", - "required":[ - "KmsKeyArn", - "EncryptionStatus" - ], - "members":{ - "KmsKeyArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption. It will display AWS_OWNED_KMS_KEY
when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.
The current state of encryption at rest for the ledger. This can be one of the following values:
ENABLED
: Encryption is fully enabled using the specified key.
UPDATING
: The ledger is actively processing the specified key change.
Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.
KMS_KEY_INACCESSIBLE
: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.
An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.
The date and time, in epoch time format, when the KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)
This parameter is undefined if the KMS key is accessible.
" - } - }, - "documentation":"Information about the encryption of data at rest in an Amazon QLDB ledger. This includes the current status, the key in Key Management Service (KMS), and when the key became inaccessible (in the case of an error).
For more information, see Encryption at rest in the Amazon QLDB Developer Guide.
" - }, - "LedgerList":{ - "type":"list", - "member":{"shape":"LedgerSummary"} - }, - "LedgerName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$" - }, - "LedgerState":{ - "type":"string", - "enum":[ - "CREATING", - "ACTIVE", - "DELETING", - "DELETED" - ] - }, - "LedgerSummary":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
" - }, - "State":{ - "shape":"LedgerState", - "documentation":"The current status of the ledger.
" - }, - "CreationDateTime":{ - "shape":"Timestamp", - "documentation":"The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
" - } - }, - "documentation":"Information about a ledger, including its name, state, and when it was created.
" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"}, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of resource.
" - } - }, - "documentation":"You have reached the limit on the maximum number of resources allowed.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "ListJournalKinesisStreamsForLedgerRequest":{ - "type":"structure", - "required":["LedgerName"], - "members":{ - "LedgerName":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return in a single ListJournalKinesisStreamsForLedger
request. (The actual number of results returned might be fewer.)
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken
in the response from a previous ListJournalKinesisStreamsForLedger
call, you should use that value as input here.
The QLDB journal streams that are currently associated with the given ledger.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If NextToken
is empty, the last page of results has been processed and there are no more results to be retrieved.
If NextToken
is not empty, more results are available. To retrieve the next page of results, use the value of NextToken
in a subsequent ListJournalKinesisStreamsForLedger
call.
The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to return in a single ListJournalS3ExportsForLedger
request. (The actual number of results returned might be fewer.)
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken
in the response from a previous ListJournalS3ExportsForLedger
call, then you should use that value as input here.
The journal export jobs that are currently associated with the specified ledger.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If NextToken
is empty, then the last page of results has been processed and there are no more results to be retrieved.
If NextToken
is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken
in a subsequent ListJournalS3ExportsForLedger
call.
The maximum number of results to return in a single ListJournalS3Exports
request. (The actual number of results returned might be fewer.)
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken
in the response from a previous ListJournalS3Exports
call, then you should use that value as input here.
The journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"If NextToken
is empty, then the last page of results has been processed and there are no more results to be retrieved.
If NextToken
is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken
in a subsequent ListJournalS3Exports
call.
The maximum number of results to return in a single ListLedgers
request. (The actual number of results returned might be fewer.)
A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken
in the response from a previous ListLedgers
call, then you should use that value as input here.
The ledgers that are associated with the current Amazon Web Services account and Region.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token, indicating whether there are more results available:
If NextToken
is empty, then the last page of results has been processed and there are no more results to be retrieved.
If NextToken
is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken
in a subsequent ListLedgers
call.
The Amazon Resource Name (ARN) for which to list the tags. For example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
The tags that are currently associated with the specified Amazon QLDB resource.
" - } - } - }, - "MaxResults":{ - "type":"integer", - "max":100, - "min":1 - }, - "NextToken":{ - "type":"string", - "max":1024, - "min":4, - "pattern":"^[A-Za-z-0-9+/=]+$" - }, - "OutputFormat":{ - "type":"string", - "enum":[ - "ION_BINARY", - "ION_TEXT", - "JSON" - ] - }, - "ParameterName":{"type":"string"}, - "PermissionsMode":{ - "type":"string", - "enum":[ - "ALLOW_ALL", - "STANDARD" - ] - }, - "ResourceAlreadyExistsException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"}, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of resource.
" - }, - "ResourceName":{ - "shape":"ResourceName", - "documentation":"The name of the resource.
" - } - }, - "documentation":"The specified resource already exists.
", - "error":{"httpStatusCode":409}, - "exception":true - }, - "ResourceInUseException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"}, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of resource.
" - }, - "ResourceName":{ - "shape":"ResourceName", - "documentation":"The name of the resource.
" - } - }, - "documentation":"The specified resource can't be modified at this time.
", - "error":{"httpStatusCode":409}, - "exception":true - }, - "ResourceName":{"type":"string"}, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"}, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of resource.
" - }, - "ResourceName":{ - "shape":"ResourceName", - "documentation":"The name of the resource.
" - } - }, - "documentation":"The specified resource doesn't exist.
", - "error":{"httpStatusCode":404}, - "exception":true - }, - "ResourcePreconditionNotMetException":{ - "type":"structure", - "members":{ - "Message":{"shape":"ErrorMessage"}, - "ResourceType":{ - "shape":"ResourceType", - "documentation":"The type of resource.
" - }, - "ResourceName":{ - "shape":"ResourceName", - "documentation":"The name of the resource.
" - } - }, - "documentation":"The operation failed because a condition wasn't satisfied in advance.
", - "error":{"httpStatusCode":412}, - "exception":true - }, - "ResourceType":{"type":"string"}, - "S3Bucket":{ - "type":"string", - "max":255, - "min":3, - "pattern":"^[A-Za-z-0-9-_.]+$" - }, - "S3EncryptionConfiguration":{ - "type":"structure", - "required":["ObjectEncryptionType"], - "members":{ - "ObjectEncryptionType":{ - "shape":"S3ObjectEncryptionType", - "documentation":"The Amazon S3 object encryption type.
To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.
" - }, - "KmsKeyArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of a symmetric encryption key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.
You must provide a KmsKeyArn
if you specify SSE_KMS
as the ObjectEncryptionType
.
KmsKeyArn
is not required if you specify SSE_S3
as the ObjectEncryptionType
.
The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.
" - }, - "S3ExportConfiguration":{ - "type":"structure", - "required":[ - "Bucket", - "Prefix", - "EncryptionConfiguration" - ], - "members":{ - "Bucket":{ - "shape":"S3Bucket", - "documentation":"The Amazon S3 bucket name in which a journal export job writes the journal contents.
The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.
" - }, - "Prefix":{ - "shape":"S3Prefix", - "documentation":"The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.
The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.
The following are examples of valid Prefix
values:
JournalExports-ForMyLedger/Testing/
JournalExports
My:Tests/
The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
" - } - }, - "documentation":"The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.
" - }, - "S3ObjectEncryptionType":{ - "type":"string", - "enum":[ - "SSE_KMS", - "SSE_S3", - "NO_ENCRYPTION" - ] - }, - "S3Prefix":{ - "type":"string", - "max":128, - "min":0 - }, - "StreamJournalToKinesisRequest":{ - "type":"structure", - "required":[ - "LedgerName", - "RoleArn", - "InclusiveStartTime", - "KinesisConfiguration", - "StreamName" - ], - "members":{ - "LedgerName":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "RoleArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole
action on the IAM role resource. This is required for all journal stream requests.
The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.
" - }, - "InclusiveStartTime":{ - "shape":"Timestamp", - "documentation":"The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601
date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
The InclusiveStartTime
cannot be in the future and must be before ExclusiveEndTime
.
If you provide an InclusiveStartTime
that is before the ledger's CreationDateTime
, QLDB effectively defaults it to the ledger's CreationDateTime
.
The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.
The ExclusiveEndTime
must be in ISO 8601
date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
.
The configuration settings of the Kinesis Data Streams destination for your stream request.
" - }, - "StreamName":{ - "shape":"StreamName", - "documentation":"The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.
Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
" - } - } - }, - "StreamJournalToKinesisResponse":{ - "type":"structure", - "members":{ - "StreamId":{ - "shape":"UniqueId", - "documentation":"The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal stream.
" - } - } - }, - "StreamName":{ - "type":"string", - "max":32, - "min":1, - "pattern":"(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$" - }, - "StreamStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "COMPLETED", - "CANCELED", - "FAILED", - "IMPAIRED" - ] - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1 - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":200, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) to which you want to add the tags. For example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0 - }, - "Tags":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":200, - "min":0 - }, - "Timestamp":{"type":"timestamp"}, - "UniqueId":{ - "type":"string", - "max":22, - "min":22, - "pattern":"^[A-Za-z-0-9]+$" - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) from which to remove the tags. For example:
arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
The list of tag keys to remove.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateLedgerPermissionsModeRequest":{ - "type":"structure", - "required":[ - "Name", - "PermissionsMode" - ], - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "PermissionsMode":{ - "shape":"PermissionsMode", - "documentation":"The permissions mode to assign to the ledger. This parameter can have one of the following values:
ALLOW_ALL
: A legacy permissions mode that enables access control with API-level granularity for ledgers.
This mode allows users who have the SendCommand
API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL
) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.
STANDARD
: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.
By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the SendCommand
API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide.
We strongly recommend using the STANDARD
permissions mode to maximize the security of your ledger data.
The name of the ledger.
" - }, - "Arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) for the ledger.
" - }, - "PermissionsMode":{ - "shape":"PermissionsMode", - "documentation":"The current permissions mode of the ledger.
" - } - } - }, - "UpdateLedgerRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
", - "location":"uri", - "locationName":"name" - }, - "DeletionProtection":{ - "shape":"DeletionProtection", - "documentation":"Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true
) by default.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger
operation to set this parameter to false
.
The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer Guide.
Use one of the following options to specify this parameter:
AWS_OWNED_KMS_KEY
: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.
Undefined: Make no changes to the KMS key of the ledger.
A valid symmetric customer managed KMS key: Use the specified symmetric encryption KMS key in your account that you create, own, and manage.
Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
" - } - } - }, - "UpdateLedgerResponse":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"LedgerName", - "documentation":"The name of the ledger.
" - }, - "Arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) for the ledger.
" - }, - "State":{ - "shape":"LedgerState", - "documentation":"The current status of the ledger.
" - }, - "CreationDateTime":{ - "shape":"Timestamp", - "documentation":"The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
" - }, - "DeletionProtection":{ - "shape":"DeletionProtection", - "documentation":"Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true
) by default.
If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger
operation to set this parameter to false
.
Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error).
" - } - } - }, - "ValueHolder":{ - "type":"structure", - "members":{ - "IonText":{ - "shape":"IonText", - "documentation":"An Amazon Ion plaintext value contained in a ValueHolder
structure.
A structure that can contain a value in multiple encoding formats.
", - "sensitive":true - } - }, - "documentation":"The resource management API for Amazon QLDB
" -} diff --git a/awscli/botocore/data/robomaker/2018-06-29/endpoint-rule-set-1.json b/awscli/botocore/data/robomaker/2018-06-29/endpoint-rule-set-1.json deleted file mode 100644 index ef24537e1648..000000000000 --- a/awscli/botocore/data/robomaker/2018-06-29/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://robomaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://robomaker-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://robomaker.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://robomaker.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/robomaker/2018-06-29/paginators-1.json b/awscli/botocore/data/robomaker/2018-06-29/paginators-1.json deleted file mode 100644 index 380e723c43f1..000000000000 --- a/awscli/botocore/data/robomaker/2018-06-29/paginators-1.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "pagination": { - "ListDeploymentJobs": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "deploymentJobs" - }, - "ListFleets": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "fleetDetails" - }, - "ListRobotApplications": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "robotApplicationSummaries" - }, - "ListRobots": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "robots" - }, - "ListSimulationApplications": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "simulationApplicationSummaries" - }, - "ListSimulationJobs": { - "input_token": "nextToken", - "limit_key": "maxResults", - "output_token": "nextToken", - "result_key": "simulationJobSummaries" - }, - "ListSimulationJobBatches": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "simulationJobBatchSummaries" - }, - "ListWorldExportJobs": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "worldExportJobSummaries" - }, - "ListWorldGenerationJobs": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "worldGenerationJobSummaries" - }, - "ListWorldTemplates": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "templateSummaries" - }, - "ListWorlds": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "worldSummaries" - } - } -} diff --git a/awscli/botocore/data/robomaker/2018-06-29/service-2.json b/awscli/botocore/data/robomaker/2018-06-29/service-2.json deleted file mode 100644 index a9612dc85e1a..000000000000 --- a/awscli/botocore/data/robomaker/2018-06-29/service-2.json +++ /dev/null @@ -1,5480 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2018-06-29", - "endpointPrefix":"robomaker", - "jsonVersion":"1.1", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceAbbreviation":"RoboMaker", - "serviceFullName":"AWS RoboMaker", - "serviceId":"RoboMaker", - "signatureVersion":"v4", - "signingName":"robomaker", - "uid":"robomaker-2018-06-29", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "BatchDeleteWorlds":{ - "name":"BatchDeleteWorlds", - "http":{ - "method":"POST", - "requestUri":"/batchDeleteWorlds" - }, - "input":{"shape":"BatchDeleteWorldsRequest"}, - "output":{"shape":"BatchDeleteWorldsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes one or more worlds in a batch operation.
" - }, - "BatchDescribeSimulationJob":{ - "name":"BatchDescribeSimulationJob", - "http":{ - "method":"POST", - "requestUri":"/batchDescribeSimulationJob" - }, - "input":{"shape":"BatchDescribeSimulationJobRequest"}, - "output":{"shape":"BatchDescribeSimulationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes one or more simulation jobs.
" - }, - "CancelDeploymentJob":{ - "name":"CancelDeploymentJob", - "http":{ - "method":"POST", - "requestUri":"/cancelDeploymentJob" - }, - "input":{"shape":"CancelDeploymentJobRequest"}, - "output":{"shape":"CancelDeploymentJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Cancels the specified deployment job.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CancelSimulationJob":{ - "name":"CancelSimulationJob", - "http":{ - "method":"POST", - "requestUri":"/cancelSimulationJob" - }, - "input":{"shape":"CancelSimulationJobRequest"}, - "output":{"shape":"CancelSimulationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels the specified simulation job.
" - }, - "CancelSimulationJobBatch":{ - "name":"CancelSimulationJobBatch", - "http":{ - "method":"POST", - "requestUri":"/cancelSimulationJobBatch" - }, - "input":{"shape":"CancelSimulationJobBatchRequest"}, - "output":{"shape":"CancelSimulationJobBatchResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
" - }, - "CancelWorldExportJob":{ - "name":"CancelWorldExportJob", - "http":{ - "method":"POST", - "requestUri":"/cancelWorldExportJob" - }, - "input":{"shape":"CancelWorldExportJobRequest"}, - "output":{"shape":"CancelWorldExportJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels the specified export job.
" - }, - "CancelWorldGenerationJob":{ - "name":"CancelWorldGenerationJob", - "http":{ - "method":"POST", - "requestUri":"/cancelWorldGenerationJob" - }, - "input":{"shape":"CancelWorldGenerationJobRequest"}, - "output":{"shape":"CancelWorldGenerationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels the specified world generator job.
" - }, - "CreateDeploymentJob":{ - "name":"CreateDeploymentJob", - "http":{ - "method":"POST", - "requestUri":"/createDeploymentJob" - }, - "input":{"shape":"CreateDeploymentJobRequest"}, - "output":{"shape":"CreateDeploymentJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"LimitExceededException"}, - {"shape":"ConcurrentDeploymentException"}, - {"shape":"IdempotentParameterMismatchException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Deploys a specific version of a robot application to robots in a fleet.
The robot application must have a numbered applicationVersion
for consistency reasons. To create a new version, use CreateRobotApplicationVersion
or see Creating a Robot Application Version.
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Creates a fleet, a logical group of robots running the same robot application.
", - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateRobot":{ - "name":"CreateRobot", - "http":{ - "method":"POST", - "requestUri":"/createRobot" - }, - "input":{"shape":"CreateRobotRequest"}, - "output":{"shape":"CreateRobotResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"LimitExceededException"}, - {"shape":"ResourceAlreadyExistsException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Creates a robot.
", - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateRobotApplication":{ - "name":"CreateRobotApplication", - "http":{ - "method":"POST", - "requestUri":"/createRobotApplication" - }, - "input":{"shape":"CreateRobotApplicationRequest"}, - "output":{"shape":"CreateRobotApplicationResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"IdempotentParameterMismatchException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a robot application.
" - }, - "CreateRobotApplicationVersion":{ - "name":"CreateRobotApplicationVersion", - "http":{ - "method":"POST", - "requestUri":"/createRobotApplicationVersion" - }, - "input":{"shape":"CreateRobotApplicationVersionRequest"}, - "output":{"shape":"CreateRobotApplicationVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"IdempotentParameterMismatchException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a version of a robot application.
" - }, - "CreateSimulationApplication":{ - "name":"CreateSimulationApplication", - "http":{ - "method":"POST", - "requestUri":"/createSimulationApplication" - }, - "input":{"shape":"CreateSimulationApplicationRequest"}, - "output":{"shape":"CreateSimulationApplicationResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"}, - {"shape":"IdempotentParameterMismatchException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a simulation application.
" - }, - "CreateSimulationApplicationVersion":{ - "name":"CreateSimulationApplicationVersion", - "http":{ - "method":"POST", - "requestUri":"/createSimulationApplicationVersion" - }, - "input":{"shape":"CreateSimulationApplicationVersionRequest"}, - "output":{"shape":"CreateSimulationApplicationVersionResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"IdempotentParameterMismatchException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a simulation application with a specific revision id.
" - }, - "CreateSimulationJob":{ - "name":"CreateSimulationJob", - "http":{ - "method":"POST", - "requestUri":"/createSimulationJob" - }, - "input":{"shape":"CreateSimulationJobRequest"}, - "output":{"shape":"CreateSimulationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"LimitExceededException"}, - {"shape":"IdempotentParameterMismatchException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a simulation job.
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a world export job.
" - }, - "CreateWorldGenerationJob":{ - "name":"CreateWorldGenerationJob", - "http":{ - "method":"POST", - "requestUri":"/createWorldGenerationJob" - }, - "input":{"shape":"CreateWorldGenerationJobRequest"}, - "output":{"shape":"CreateWorldGenerationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"LimitExceededException"}, - {"shape":"IdempotentParameterMismatchException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates worlds using the specified template.
" - }, - "CreateWorldTemplate":{ - "name":"CreateWorldTemplate", - "http":{ - "method":"POST", - "requestUri":"/createWorldTemplate" - }, - "input":{"shape":"CreateWorldTemplateRequest"}, - "output":{"shape":"CreateWorldTemplateResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceAlreadyExistsException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a world template.
" - }, - "DeleteFleet":{ - "name":"DeleteFleet", - "http":{ - "method":"POST", - "requestUri":"/deleteFleet" - }, - "input":{"shape":"DeleteFleetRequest"}, - "output":{"shape":"DeleteFleetResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Deletes a fleet.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DeleteRobot":{ - "name":"DeleteRobot", - "http":{ - "method":"POST", - "requestUri":"/deleteRobot" - }, - "input":{"shape":"DeleteRobotRequest"}, - "output":{"shape":"DeleteRobotResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Deletes a robot.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DeleteRobotApplication":{ - "name":"DeleteRobotApplication", - "http":{ - "method":"POST", - "requestUri":"/deleteRobotApplication" - }, - "input":{"shape":"DeleteRobotApplicationRequest"}, - "output":{"shape":"DeleteRobotApplicationResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes a robot application.
" - }, - "DeleteSimulationApplication":{ - "name":"DeleteSimulationApplication", - "http":{ - "method":"POST", - "requestUri":"/deleteSimulationApplication" - }, - "input":{"shape":"DeleteSimulationApplicationRequest"}, - "output":{"shape":"DeleteSimulationApplicationResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes a simulation application.
" - }, - "DeleteWorldTemplate":{ - "name":"DeleteWorldTemplate", - "http":{ - "method":"POST", - "requestUri":"/deleteWorldTemplate" - }, - "input":{"shape":"DeleteWorldTemplateRequest"}, - "output":{"shape":"DeleteWorldTemplateResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes a world template.
" - }, - "DeregisterRobot":{ - "name":"DeregisterRobot", - "http":{ - "method":"POST", - "requestUri":"/deregisterRobot" - }, - "input":{"shape":"DeregisterRobotRequest"}, - "output":{"shape":"DeregisterRobotResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Deregisters a robot.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeDeploymentJob":{ - "name":"DescribeDeploymentJob", - "http":{ - "method":"POST", - "requestUri":"/describeDeploymentJob" - }, - "input":{"shape":"DescribeDeploymentJobRequest"}, - "output":{"shape":"DescribeDeploymentJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Describes a deployment job.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeFleet":{ - "name":"DescribeFleet", - "http":{ - "method":"POST", - "requestUri":"/describeFleet" - }, - "input":{"shape":"DescribeFleetRequest"}, - "output":{"shape":"DescribeFleetResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Describes a fleet.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeRobot":{ - "name":"DescribeRobot", - "http":{ - "method":"POST", - "requestUri":"/describeRobot" - }, - "input":{"shape":"DescribeRobotRequest"}, - "output":{"shape":"DescribeRobotResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Describes a robot.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeRobotApplication":{ - "name":"DescribeRobotApplication", - "http":{ - "method":"POST", - "requestUri":"/describeRobotApplication" - }, - "input":{"shape":"DescribeRobotApplicationRequest"}, - "output":{"shape":"DescribeRobotApplicationResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a robot application.
" - }, - "DescribeSimulationApplication":{ - "name":"DescribeSimulationApplication", - "http":{ - "method":"POST", - "requestUri":"/describeSimulationApplication" - }, - "input":{"shape":"DescribeSimulationApplicationRequest"}, - "output":{"shape":"DescribeSimulationApplicationResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a simulation application.
" - }, - "DescribeSimulationJob":{ - "name":"DescribeSimulationJob", - "http":{ - "method":"POST", - "requestUri":"/describeSimulationJob" - }, - "input":{"shape":"DescribeSimulationJobRequest"}, - "output":{"shape":"DescribeSimulationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a simulation job.
" - }, - "DescribeSimulationJobBatch":{ - "name":"DescribeSimulationJobBatch", - "http":{ - "method":"POST", - "requestUri":"/describeSimulationJobBatch" - }, - "input":{"shape":"DescribeSimulationJobBatchRequest"}, - "output":{"shape":"DescribeSimulationJobBatchResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a simulation job batch.
" - }, - "DescribeWorld":{ - "name":"DescribeWorld", - "http":{ - "method":"POST", - "requestUri":"/describeWorld" - }, - "input":{"shape":"DescribeWorldRequest"}, - "output":{"shape":"DescribeWorldResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world.
" - }, - "DescribeWorldExportJob":{ - "name":"DescribeWorldExportJob", - "http":{ - "method":"POST", - "requestUri":"/describeWorldExportJob" - }, - "input":{"shape":"DescribeWorldExportJobRequest"}, - "output":{"shape":"DescribeWorldExportJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world export job.
" - }, - "DescribeWorldGenerationJob":{ - "name":"DescribeWorldGenerationJob", - "http":{ - "method":"POST", - "requestUri":"/describeWorldGenerationJob" - }, - "input":{"shape":"DescribeWorldGenerationJobRequest"}, - "output":{"shape":"DescribeWorldGenerationJobResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world generation job.
" - }, - "DescribeWorldTemplate":{ - "name":"DescribeWorldTemplate", - "http":{ - "method":"POST", - "requestUri":"/describeWorldTemplate" - }, - "input":{"shape":"DescribeWorldTemplateRequest"}, - "output":{"shape":"DescribeWorldTemplateResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world template.
" - }, - "GetWorldTemplateBody":{ - "name":"GetWorldTemplateBody", - "http":{ - "method":"POST", - "requestUri":"/getWorldTemplateBody" - }, - "input":{"shape":"GetWorldTemplateBodyRequest"}, - "output":{"shape":"GetWorldTemplateBodyResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Gets the world template body.
" - }, - "ListDeploymentJobs":{ - "name":"ListDeploymentJobs", - "http":{ - "method":"POST", - "requestUri":"/listDeploymentJobs" - }, - "input":{"shape":"ListDeploymentJobsRequest"}, - "output":{"shape":"ListDeploymentJobsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "ListFleets":{ - "name":"ListFleets", - "http":{ - "method":"POST", - "requestUri":"/listFleets" - }, - "input":{"shape":"ListFleetsRequest"}, - "output":{"shape":"ListFleetsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "ListRobotApplications":{ - "name":"ListRobotApplications", - "http":{ - "method":"POST", - "requestUri":"/listRobotApplications" - }, - "input":{"shape":"ListRobotApplicationsRequest"}, - "output":{"shape":"ListRobotApplicationsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
" - }, - "ListRobots":{ - "name":"ListRobots", - "http":{ - "method":"POST", - "requestUri":"/listRobots" - }, - "input":{"shape":"ListRobotsRequest"}, - "output":{"shape":"ListRobotsResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "ListSimulationApplications":{ - "name":"ListSimulationApplications", - "http":{ - "method":"POST", - "requestUri":"/listSimulationApplications" - }, - "input":{"shape":"ListSimulationApplicationsRequest"}, - "output":{"shape":"ListSimulationApplicationsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
" - }, - "ListSimulationJobBatches":{ - "name":"ListSimulationJobBatches", - "http":{ - "method":"POST", - "requestUri":"/listSimulationJobBatches" - }, - "input":{"shape":"ListSimulationJobBatchesRequest"}, - "output":{"shape":"ListSimulationJobBatchesResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
" - }, - "ListSimulationJobs":{ - "name":"ListSimulationJobs", - "http":{ - "method":"POST", - "requestUri":"/listSimulationJobs" - }, - "input":{"shape":"ListSimulationJobsRequest"}, - "output":{"shape":"ListSimulationJobsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists all tags on a AWS RoboMaker resource.
" - }, - "ListWorldExportJobs":{ - "name":"ListWorldExportJobs", - "http":{ - "method":"POST", - "requestUri":"/listWorldExportJobs" - }, - "input":{"shape":"ListWorldExportJobsRequest"}, - "output":{"shape":"ListWorldExportJobsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists world export jobs.
" - }, - "ListWorldGenerationJobs":{ - "name":"ListWorldGenerationJobs", - "http":{ - "method":"POST", - "requestUri":"/listWorldGenerationJobs" - }, - "input":{"shape":"ListWorldGenerationJobsRequest"}, - "output":{"shape":"ListWorldGenerationJobsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists world generator jobs.
" - }, - "ListWorldTemplates":{ - "name":"ListWorldTemplates", - "http":{ - "method":"POST", - "requestUri":"/listWorldTemplates" - }, - "input":{"shape":"ListWorldTemplatesRequest"}, - "output":{"shape":"ListWorldTemplatesResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists world templates.
" - }, - "ListWorlds":{ - "name":"ListWorlds", - "http":{ - "method":"POST", - "requestUri":"/listWorlds" - }, - "input":{"shape":"ListWorldsRequest"}, - "output":{"shape":"ListWorldsResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists worlds.
" - }, - "RegisterRobot":{ - "name":"RegisterRobot", - "http":{ - "method":"POST", - "requestUri":"/registerRobot" - }, - "input":{"shape":"RegisterRobotRequest"}, - "output":{"shape":"RegisterRobotResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"LimitExceededException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Registers a robot with a fleet.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Restarts a running simulation job.
" - }, - "StartSimulationJobBatch":{ - "name":"StartSimulationJobBatch", - "http":{ - "method":"POST", - "requestUri":"/startSimulationJobBatch" - }, - "input":{"shape":"StartSimulationJobBatchRequest"}, - "output":{"shape":"StartSimulationJobBatchResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"IdempotentParameterMismatchException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest
objects.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
", - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Adds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidParameterException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Removes the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource
.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Updates a robot application.
" - }, - "UpdateSimulationApplication":{ - "name":"UpdateSimulationApplication", - "http":{ - "method":"POST", - "requestUri":"/updateSimulationApplication" - }, - "input":{"shape":"UpdateSimulationApplicationRequest"}, - "output":{"shape":"UpdateSimulationApplicationResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Updates a simulation application.
" - }, - "UpdateWorldTemplate":{ - "name":"UpdateWorldTemplate", - "http":{ - "method":"POST", - "requestUri":"/updateWorldTemplate" - }, - "input":{"shape":"UpdateWorldTemplateRequest"}, - "output":{"shape":"UpdateWorldTemplateResponse"}, - "errors":[ - {"shape":"InvalidParameterException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalServerException"} - ], - "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Updates a world template.
" - } - }, - "shapes":{ - "Architecture":{ - "type":"string", - "enum":[ - "X86_64", - "ARM64", - "ARMHF" - ] - }, - "Arn":{ - "type":"string", - "max":1224, - "min":1, - "pattern":"arn:.*" - }, - "Arns":{ - "type":"list", - "member":{"shape":"Arn"}, - "max":100, - "min":1 - }, - "BatchDeleteWorldsRequest":{ - "type":"structure", - "required":["worlds"], - "members":{ - "worlds":{ - "shape":"Arns", - "documentation":"A list of Amazon Resource Names (arns) that correspond to worlds to delete.
" - } - } - }, - "BatchDeleteWorldsResponse":{ - "type":"structure", - "members":{ - "unprocessedWorlds":{ - "shape":"Arns", - "documentation":"A list of unprocessed worlds associated with the call. These worlds were not deleted.
" - } - } - }, - "BatchDescribeSimulationJobRequest":{ - "type":"structure", - "required":["jobs"], - "members":{ - "jobs":{ - "shape":"Arns", - "documentation":"A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
" - } - } - }, - "BatchDescribeSimulationJobResponse":{ - "type":"structure", - "members":{ - "jobs":{ - "shape":"SimulationJobs", - "documentation":"A list of simulation jobs.
" - }, - "unprocessedJobs":{ - "shape":"Arns", - "documentation":"A list of unprocessed simulation job Amazon Resource Names (ARNs).
" - } - } - }, - "BatchPolicy":{ - "type":"structure", - "members":{ - "timeoutInSeconds":{ - "shape":"BatchTimeoutInSeconds", - "documentation":"The amount of time, in seconds, to wait for the batch to complete.
If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError
), they will be moved to the failed list and the batch status will be Failed
. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut
.
The number of active simulation jobs create as part of the batch that can be in an active state at the same time.
Active states include: Pending
,Preparing
, Running
, Restarting
, RunningFailed
and Terminating
. All other states are terminal states.
Information about the batch policy.
" - }, - "BatchTimeoutInSeconds":{"type":"long"}, - "Boolean":{"type":"boolean"}, - "BoxedBoolean":{"type":"boolean"}, - "CancelDeploymentJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The deployment job ARN to cancel.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CancelDeploymentJobResponse":{ - "type":"structure", - "members":{}, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CancelSimulationJobBatchRequest":{ - "type":"structure", - "required":["batch"], - "members":{ - "batch":{ - "shape":"Arn", - "documentation":"The id of the batch to cancel.
" - } - } - }, - "CancelSimulationJobBatchResponse":{ - "type":"structure", - "members":{} - }, - "CancelSimulationJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The simulation job ARN to cancel.
" - } - } - }, - "CancelSimulationJobResponse":{ - "type":"structure", - "members":{} - }, - "CancelWorldExportJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world export job to cancel.
" - } - } - }, - "CancelWorldExportJobResponse":{ - "type":"structure", - "members":{} - }, - "CancelWorldGenerationJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world generator job to cancel.
" - } - } - }, - "CancelWorldGenerationJobResponse":{ - "type":"structure", - "members":{} - }, - "ClientRequestToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"[a-zA-Z0-9_\\-=]*" - }, - "Command":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[a-zA-Z0-9_.\\-]*" - }, - "CommandList":{ - "type":"list", - "member":{"shape":"NonEmptyString"} - }, - "Compute":{ - "type":"structure", - "members":{ - "simulationUnitLimit":{ - "shape":"SimulationUnit", - "documentation":"The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.
" - }, - "computeType":{ - "shape":"ComputeType", - "documentation":"Compute type information for the simulation job.
" - }, - "gpuUnitLimit":{ - "shape":"GPUUnit", - "documentation":"Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.
" - } - }, - "documentation":"Compute information for the simulation job.
" - }, - "ComputeResponse":{ - "type":"structure", - "members":{ - "simulationUnitLimit":{ - "shape":"SimulationUnit", - "documentation":"The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.
" - }, - "computeType":{ - "shape":"ComputeType", - "documentation":"Compute type response information for the simulation job.
" - }, - "gpuUnitLimit":{ - "shape":"GPUUnit", - "documentation":"Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.
" - } - }, - "documentation":"Compute information for the simulation job
" - }, - "ComputeType":{ - "type":"string", - "enum":[ - "CPU", - "GPU_AND_CPU" - ] - }, - "ConcurrentDeploymentException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The failure percentage threshold percentage was met.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "CreateDeploymentJobRequest":{ - "type":"structure", - "required":[ - "clientRequestToken", - "fleet", - "deploymentApplicationConfigs" - ], - "members":{ - "deploymentConfig":{ - "shape":"DeploymentConfig", - "documentation":"The requested deployment configuration.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "idempotencyToken":true - }, - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet to deploy.
" - }, - "deploymentApplicationConfigs":{ - "shape":"DeploymentApplicationConfigs", - "documentation":"The deployment application configuration.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the deployment job.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateDeploymentJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the deployment job.
" - }, - "fleet":{ - "shape":"Arn", - "documentation":"The target fleet for the deployment job.
" - }, - "status":{ - "shape":"DeploymentStatus", - "documentation":"The status of the deployment job.
" - }, - "deploymentApplicationConfigs":{ - "shape":"DeploymentApplicationConfigs", - "documentation":"The deployment application configuration.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"The failure reason of the deployment job if it failed.
" - }, - "failureCode":{ - "shape":"DeploymentJobErrorCode", - "documentation":"The failure code of the simulation job if it failed:
AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy
managed policy.
The robot application could not be extracted from the bundle.
The percentage of robots that could not be updated exceeded the percentage set for the deployment.
The robot application could not be deployed to the robot.
The AWS Greengrass group or version associated with a robot is missing.
An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
The robot application does not have a source that matches the architecture of the robot.
One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
The post-launch script failed.
The pre-launch script failed.
One or more deployment resources are missing. For example, do robot application source bundles still exist?
There is no response from the robot. It might not be powered on or connected to the internet.
The time, in milliseconds since the epoch, when the fleet was created.
" - }, - "deploymentConfig":{ - "shape":"DeploymentConfig", - "documentation":"The deployment configuration.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the deployment job.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateFleetRequest":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the fleet.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the fleet.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateFleetResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the fleet.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the fleet was created.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the fleet.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateRobotApplicationRequest":{ - "type":"structure", - "required":[ - "name", - "robotSoftwareSuite" - ], - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the robot application.
" - }, - "sources":{ - "shape":"SourceConfigs", - "documentation":"The sources of the robot application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite used by the robot application.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the robot application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains that URI of the Docker image that you use for your robot application.
" - } - } - }, - "CreateRobotApplicationResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the robot application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the robot application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the robot application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite used by the robot application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot application was last updated.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision id of the robot application.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the robot application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"An object that contains the Docker image URI used to a create your robot application.
" - } - } - }, - "CreateRobotApplicationVersionRequest":{ - "type":"structure", - "required":["application"], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the robot application.
" - }, - "currentRevisionId":{ - "shape":"RevisionId", - "documentation":"The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.
" - }, - "s3Etags":{ - "shape":"S3Etags", - "documentation":"The Amazon S3 identifier for the zip file bundle that you use for your robot application.
" - }, - "imageDigest":{ - "shape":"ImageDigest", - "documentation":"A SHA256 identifier for the Docker image that you use for your robot application.
" - } - } - }, - "CreateRobotApplicationVersionResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the robot application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the robot application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the robot application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite used by the robot application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot application was last updated.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision id of the robot application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI used to create your robot application.
" - } - } - }, - "CreateRobotRequest":{ - "type":"structure", - "required":[ - "name", - "architecture", - "greengrassGroupId" - ], - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name for the robot.
" - }, - "architecture":{ - "shape":"Architecture", - "documentation":"The target architecture of the robot.
" - }, - "greengrassGroupId":{ - "shape":"Id", - "documentation":"The Greengrass group id.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the robot.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateRobotResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the robot.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot was created.
" - }, - "greengrassGroupId":{ - "shape":"Id", - "documentation":"The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
" - }, - "architecture":{ - "shape":"Architecture", - "documentation":"The target architecture of the robot.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the robot.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "CreateSimulationApplicationRequest":{ - "type":"structure", - "required":[ - "name", - "simulationSoftwareSuite", - "robotSoftwareSuite" - ], - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the simulation application.
" - }, - "sources":{ - "shape":"SourceConfigs", - "documentation":"The sources of the simulation application.
" - }, - "simulationSoftwareSuite":{ - "shape":"SimulationSoftwareSuite", - "documentation":"The simulation software suite used by the simulation application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite used by the simulation application.
" - }, - "renderingEngine":{ - "shape":"RenderingEngine", - "documentation":"The rendering engine for the simulation application.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the simulation application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI used to create your simulation application.
" - } - } - }, - "CreateSimulationApplicationResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the simulation application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the simulation application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the simulation application.
" - }, - "simulationSoftwareSuite":{ - "shape":"SimulationSoftwareSuite", - "documentation":"The simulation software suite used by the simulation application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite.
" - }, - "renderingEngine":{ - "shape":"RenderingEngine", - "documentation":"The rendering engine for the simulation application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation application was last updated.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision id of the simulation application.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the simulation application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI that you used to create your simulation application.
" - } - } - }, - "CreateSimulationApplicationVersionRequest":{ - "type":"structure", - "required":["application"], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the simulation application.
" - }, - "currentRevisionId":{ - "shape":"RevisionId", - "documentation":"The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.
" - }, - "s3Etags":{ - "shape":"S3Etags", - "documentation":"The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.
" - }, - "imageDigest":{ - "shape":"ImageDigest", - "documentation":"The SHA256 digest used to identify the Docker image URI used to created the simulation application.
" - } - } - }, - "CreateSimulationApplicationVersionResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the simulation application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the simulation application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the simulation application.
" - }, - "simulationSoftwareSuite":{ - "shape":"SimulationSoftwareSuite", - "documentation":"The simulation software suite used by the simulation application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite.
" - }, - "renderingEngine":{ - "shape":"RenderingEngine", - "documentation":"The rendering engine for the simulation application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation application was last updated.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision ID of the simulation application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI used to create the simulation application.
" - } - } - }, - "CreateSimulationJobRequest":{ - "type":"structure", - "required":[ - "maxJobDurationInSeconds", - "iamRole" - ], - "members":{ - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "idempotencyToken":true - }, - "outputLocation":{ - "shape":"OutputLocation", - "documentation":"Location for output files generated by the simulation job.
" - }, - "loggingConfig":{ - "shape":"LoggingConfig", - "documentation":"The logging configuration.
" - }, - "maxJobDurationInSeconds":{ - "shape":"JobDuration", - "documentation":"The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds
is reached, the simulation job will status will transition to Completed
.
The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
" - }, - "failureBehavior":{ - "shape":"FailureBehavior", - "documentation":"The failure behavior the simulation job.
Leaves the instance running for its maximum timeout duration after a 4XX
error code.
Stop the simulation job and terminate the instance.
The robot application to use in the simulation job.
" - }, - "simulationApplications":{ - "shape":"SimulationApplicationConfigs", - "documentation":"The simulation application to use in the simulation job.
" - }, - "dataSources":{ - "shape":"DataSourceConfigs", - "documentation":"Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name
.
There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig
objects.
A map that contains tag keys and tag values that are attached to the simulation job.
" - }, - "vpcConfig":{ - "shape":"VPCConfig", - "documentation":"If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
" - }, - "compute":{ - "shape":"Compute", - "documentation":"Compute information for the simulation job.
" - } - } - }, - "CreateSimulationJobRequests":{ - "type":"list", - "member":{"shape":"SimulationJobRequest"}, - "max":1000, - "min":1 - }, - "CreateSimulationJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation job.
" - }, - "status":{ - "shape":"SimulationJobStatus", - "documentation":"The status of the simulation job.
" - }, - "lastStartedAt":{ - "shape":"LastStartedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job was last started.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job was last updated.
" - }, - "failureBehavior":{ - "shape":"FailureBehavior", - "documentation":"the failure behavior for the simulation job.
" - }, - "failureCode":{ - "shape":"SimulationJobErrorCode", - "documentation":"The failure code of the simulation job if it failed:
Internal service error.
Robot application exited abnormally.
Simulation application exited abnormally.
Robot application bundle could not be downloaded.
Simulation application bundle could not be downloaded.
Unable to publish outputs to customer-provided S3 bucket.
Unable to publish logs to customer-provided CloudWatch Logs resource.
Subnet IP limit exceeded.
ENI limit exceeded.
Unable to use the Role provided.
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
Etag for RobotApplication does not match value during version creation.
Etag for SimulationApplication does not match value during version creation.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "outputLocation":{ - "shape":"OutputLocation", - "documentation":"Simulation job output files location.
" - }, - "loggingConfig":{ - "shape":"LoggingConfig", - "documentation":"The logging configuration.
" - }, - "maxJobDurationInSeconds":{ - "shape":"JobDuration", - "documentation":"The maximum simulation job duration in seconds.
" - }, - "simulationTimeMillis":{ - "shape":"SimulationTimeMillis", - "documentation":"The simulation job execution duration in milliseconds.
" - }, - "iamRole":{ - "shape":"IamRole", - "documentation":"The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
" - }, - "robotApplications":{ - "shape":"RobotApplicationConfigs", - "documentation":"The robot application used by the simulation job.
" - }, - "simulationApplications":{ - "shape":"SimulationApplicationConfigs", - "documentation":"The simulation application used by the simulation job.
" - }, - "dataSources":{ - "shape":"DataSources", - "documentation":"The data sources for the simulation job.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the simulation job.
" - }, - "vpcConfig":{ - "shape":"VPCConfigResponse", - "documentation":"Information about the vpc configuration.
" - }, - "compute":{ - "shape":"ComputeResponse", - "documentation":"Compute information for the simulation job.
" - } - } - }, - "CreateWorldExportJobRequest":{ - "type":"structure", - "required":[ - "worlds", - "outputLocation", - "iamRole" - ], - "members":{ - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "idempotencyToken":true - }, - "worlds":{ - "shape":"Arns", - "documentation":"A list of Amazon Resource Names (arns) that correspond to worlds to export.
" - }, - "outputLocation":{"shape":"OutputLocation"}, - "iamRole":{ - "shape":"IamRole", - "documentation":"The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world export job.
" - } - } - }, - "CreateWorldExportJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world export job.
" - }, - "status":{ - "shape":"WorldExportJobStatus", - "documentation":"The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode
for more information.
The world export job was cancelled.
The world export job is being cancelled.
The time, in milliseconds since the epoch, when the world export job was created.
" - }, - "failureCode":{ - "shape":"WorldExportJobErrorCode", - "documentation":"The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
All of the worlds in the world generation job failed. This can happen if your worldCount
is greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "outputLocation":{"shape":"OutputLocation"}, - "iamRole":{ - "shape":"IamRole", - "documentation":"The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world export job.
" - } - } - }, - "CreateWorldGenerationJobRequest":{ - "type":"structure", - "required":[ - "template", - "worldCount" - ], - "members":{ - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "idempotencyToken":true - }, - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
" - }, - "worldCount":{ - "shape":"WorldCount", - "documentation":"Information about the world count.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world generator job.
" - }, - "worldTags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the generated worlds.
" - } - } - }, - "CreateWorldGenerationJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world generator job.
" - }, - "status":{ - "shape":"WorldGenerationJobStatus", - "documentation":"The status of the world generator job.
The world generator job request is pending.
The world generator job is running.
The world generator job completed.
The world generator job failed. See failureCode
for more information.
Some worlds did not generate.
The world generator job was cancelled.
The world generator job is being cancelled.
The time, in milliseconds since the epoch, when the world generator job was created.
" - }, - "failureCode":{ - "shape":"WorldGenerationJobErrorCode", - "documentation":"The failure code of the world generator job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template.
" - }, - "worldCount":{ - "shape":"WorldCount", - "documentation":"Information about the world count.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world generator job.
" - }, - "worldTags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the generated worlds.
" - } - } - }, - "CreateWorldTemplateRequest":{ - "type":"structure", - "members":{ - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "name":{ - "shape":"TemplateName", - "documentation":"The name of the world template.
" - }, - "templateBody":{ - "shape":"Json", - "documentation":"The world template body.
" - }, - "templateLocation":{ - "shape":"TemplateLocation", - "documentation":"The location of the world template.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world template.
" - } - } - }, - "CreateWorldTemplateResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world template.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world template was created.
" - }, - "name":{ - "shape":"TemplateName", - "documentation":"The name of the world template.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world template.
" - } - } - }, - "CreatedAt":{"type":"timestamp"}, - "DataSource":{ - "type":"structure", - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the data source.
" - }, - "s3Bucket":{ - "shape":"S3Bucket", - "documentation":"The S3 bucket where the data files are located.
" - }, - "s3Keys":{ - "shape":"S3KeyOutputs", - "documentation":"The list of S3 keys identifying the data source files.
" - }, - "type":{ - "shape":"DataSourceType", - "documentation":"The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.
If you don't specify a field, the default value is File
.
The location where your files are mounted in the container image.
If you've specified the type
of the data source as an Archive
, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip
or .tar.gz
file.
If you've specified the type
of the data source as a Prefix
, you provide the Amazon S3 prefix that points to the files that you are using for your data source.
If you've specified the type
of the data source as a File
, you provide the Amazon S3 path to the file that you're using as your data source.
Information about a data source.
" - }, - "DataSourceConfig":{ - "type":"structure", - "required":[ - "name", - "s3Bucket", - "s3Keys" - ], - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the data source.
" - }, - "s3Bucket":{ - "shape":"S3Bucket", - "documentation":"The S3 bucket where the data files are located.
" - }, - "s3Keys":{ - "shape":"S3KeysOrPrefixes", - "documentation":"The list of S3 keys identifying the data source files.
" - }, - "type":{ - "shape":"DataSourceType", - "documentation":"The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.
If you don't specify a field, the default value is File
.
The location where your files are mounted in the container image.
If you've specified the type
of the data source as an Archive
, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip
or .tar.gz
file.
If you've specified the type
of the data source as a Prefix
, you provide the Amazon S3 prefix that points to the files that you are using for your data source.
If you've specified the type
of the data source as a File
, you provide the Amazon S3 path to the file that you're using as your data source.
Information about a data source.
" - }, - "DataSourceConfigs":{ - "type":"list", - "member":{"shape":"DataSourceConfig"}, - "max":6, - "min":1 - }, - "DataSourceNames":{ - "type":"list", - "member":{"shape":"Name"} - }, - "DataSourceType":{ - "type":"string", - "enum":[ - "Prefix", - "Archive", - "File" - ] - }, - "DataSources":{ - "type":"list", - "member":{"shape":"DataSource"} - }, - "DeleteFleetRequest":{ - "type":"structure", - "required":["fleet"], - "members":{ - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DeleteFleetResponse":{ - "type":"structure", - "members":{}, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DeleteRobotApplicationRequest":{ - "type":"structure", - "required":["application"], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the the robot application.
" - }, - "applicationVersion":{ - "shape":"Version", - "documentation":"The version of the robot application to delete.
" - } - } - }, - "DeleteRobotApplicationResponse":{ - "type":"structure", - "members":{} - }, - "DeleteRobotRequest":{ - "type":"structure", - "required":["robot"], - "members":{ - "robot":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DeleteRobotResponse":{ - "type":"structure", - "members":{}, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DeleteSimulationApplicationRequest":{ - "type":"structure", - "required":["application"], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the simulation application to delete.
" - }, - "applicationVersion":{ - "shape":"Version", - "documentation":"The version of the simulation application to delete.
" - } - } - }, - "DeleteSimulationApplicationResponse":{ - "type":"structure", - "members":{} - }, - "DeleteWorldTemplateRequest":{ - "type":"structure", - "required":["template"], - "members":{ - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template you want to delete.
" - } - } - }, - "DeleteWorldTemplateResponse":{ - "type":"structure", - "members":{} - }, - "DeploymentApplicationConfig":{ - "type":"structure", - "required":[ - "application", - "applicationVersion", - "launchConfig" - ], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot application.
" - }, - "applicationVersion":{ - "shape":"DeploymentVersion", - "documentation":"The version of the application.
" - }, - "launchConfig":{ - "shape":"DeploymentLaunchConfig", - "documentation":"The launch configuration.
" - } - }, - "documentation":"Information about a deployment application configuration.
" - }, - "DeploymentApplicationConfigs":{ - "type":"list", - "member":{"shape":"DeploymentApplicationConfig"}, - "max":1, - "min":1 - }, - "DeploymentConfig":{ - "type":"structure", - "members":{ - "concurrentDeploymentPercentage":{ - "shape":"Percentage", - "documentation":"The percentage of robots receiving the deployment at the same time.
" - }, - "failureThresholdPercentage":{ - "shape":"Percentage", - "documentation":"The percentage of deployments that need to fail before stopping deployment.
" - }, - "robotDeploymentTimeoutInSeconds":{ - "shape":"DeploymentTimeout", - "documentation":"The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
" - }, - "downloadConditionFile":{ - "shape":"S3Object", - "documentation":"The download condition file.
" - } - }, - "documentation":"Information about a deployment configuration.
" - }, - "DeploymentJob":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the deployment job.
" - }, - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "status":{ - "shape":"DeploymentStatus", - "documentation":"The status of the deployment job.
" - }, - "deploymentApplicationConfigs":{ - "shape":"DeploymentApplicationConfigs", - "documentation":"The deployment application configuration.
" - }, - "deploymentConfig":{ - "shape":"DeploymentConfig", - "documentation":"The deployment configuration.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"A short description of the reason why the deployment job failed.
" - }, - "failureCode":{ - "shape":"DeploymentJobErrorCode", - "documentation":"The deployment job failure code.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the deployment job was created.
" - } - }, - "documentation":"Information about a deployment job.
" - }, - "DeploymentJobErrorCode":{ - "type":"string", - "enum":[ - "ResourceNotFound", - "EnvironmentSetupError", - "EtagMismatch", - "FailureThresholdBreached", - "RobotDeploymentAborted", - "RobotDeploymentNoResponse", - "RobotAgentConnectionTimeout", - "GreengrassDeploymentFailed", - "InvalidGreengrassGroup", - "MissingRobotArchitecture", - "MissingRobotApplicationArchitecture", - "MissingRobotDeploymentResource", - "GreengrassGroupVersionDoesNotExist", - "LambdaDeleted", - "ExtractingBundleFailure", - "PreLaunchFileFailure", - "PostLaunchFileFailure", - "BadPermissionError", - "DownloadConditionFailed", - "BadLambdaAssociated", - "InternalServerError", - "RobotApplicationDoesNotExist", - "DeploymentFleetDoesNotExist", - "FleetDeploymentTimeout" - ] - }, - "DeploymentJobs":{ - "type":"list", - "member":{"shape":"DeploymentJob"}, - "max":200, - "min":0 - }, - "DeploymentLaunchConfig":{ - "type":"structure", - "required":[ - "packageName", - "launchFile" - ], - "members":{ - "packageName":{ - "shape":"Command", - "documentation":"The package name.
" - }, - "preLaunchFile":{ - "shape":"Path", - "documentation":"The deployment pre-launch file. This file will be executed prior to the launch file.
" - }, - "launchFile":{ - "shape":"Command", - "documentation":"The launch file name.
" - }, - "postLaunchFile":{ - "shape":"Path", - "documentation":"The deployment post-launch file. This file will be executed after the launch file.
" - }, - "environmentVariables":{ - "shape":"EnvironmentVariableMap", - "documentation":"An array of key/value pairs specifying environment variables for the robot application
" - } - }, - "documentation":"Configuration information for a deployment launch.
" - }, - "DeploymentStatus":{ - "type":"string", - "enum":[ - "Pending", - "Preparing", - "InProgress", - "Failed", - "Succeeded", - "Canceled" - ] - }, - "DeploymentTimeout":{"type":"long"}, - "DeploymentVersion":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[0-9]*" - }, - "DeregisterRobotRequest":{ - "type":"structure", - "required":[ - "fleet", - "robot" - ], - "members":{ - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "robot":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DeregisterRobotResponse":{ - "type":"structure", - "members":{ - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "robot":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeDeploymentJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the deployment job.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeDeploymentJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the deployment job.
" - }, - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "status":{ - "shape":"DeploymentStatus", - "documentation":"The status of the deployment job.
" - }, - "deploymentConfig":{ - "shape":"DeploymentConfig", - "documentation":"The deployment configuration.
" - }, - "deploymentApplicationConfigs":{ - "shape":"DeploymentApplicationConfigs", - "documentation":"The deployment application configuration.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"A short description of the reason why the deployment job failed.
" - }, - "failureCode":{ - "shape":"DeploymentJobErrorCode", - "documentation":"The deployment job failure code.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the deployment job was created.
" - }, - "robotDeploymentSummary":{ - "shape":"RobotDeploymentSummary", - "documentation":"A list of robot deployment summaries.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the specified deployment job.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeFleetRequest":{ - "type":"structure", - "required":["fleet"], - "members":{ - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeFleetResponse":{ - "type":"structure", - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the fleet.
" - }, - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "robots":{ - "shape":"Robots", - "documentation":"A list of robots.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the fleet was created.
" - }, - "lastDeploymentStatus":{ - "shape":"DeploymentStatus", - "documentation":"The status of the last deployment.
" - }, - "lastDeploymentJob":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the last deployment job.
" - }, - "lastDeploymentTime":{ - "shape":"CreatedAt", - "documentation":"The time of the last deployment.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the specified fleet.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeRobotApplicationRequest":{ - "type":"structure", - "required":["application"], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot application.
" - }, - "applicationVersion":{ - "shape":"Version", - "documentation":"The version of the robot application to describe.
" - } - } - }, - "DescribeRobotApplicationResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the robot application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the robot application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the robot application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite used by the robot application.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision id of the robot application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot application was last updated.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the specified robot application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI used to create the robot application.
" - }, - "imageDigest":{ - "shape":"ImageDigest", - "documentation":"A SHA256 identifier for the Docker image that you use for your robot application.
" - } - } - }, - "DescribeRobotRequest":{ - "type":"structure", - "required":["robot"], - "members":{ - "robot":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot to be described.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeRobotResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the robot.
" - }, - "fleetArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "status":{ - "shape":"RobotStatus", - "documentation":"The status of the fleet.
" - }, - "greengrassGroupId":{ - "shape":"Id", - "documentation":"The Greengrass group id.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot was created.
" - }, - "architecture":{ - "shape":"Architecture", - "documentation":"The target architecture of the robot application.
" - }, - "lastDeploymentJob":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the last deployment job.
" - }, - "lastDeploymentTime":{ - "shape":"CreatedAt", - "documentation":"The time of the last deployment job.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the specified robot.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "DescribeSimulationApplicationRequest":{ - "type":"structure", - "required":["application"], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the simulation application.
" - }, - "applicationVersion":{ - "shape":"Version", - "documentation":"The version of the simulation application to describe.
" - } - } - }, - "DescribeSimulationApplicationResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot simulation application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the simulation application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the simulation application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the simulation application.
" - }, - "simulationSoftwareSuite":{ - "shape":"SimulationSoftwareSuite", - "documentation":"The simulation software suite used by the simulation application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite.
" - }, - "renderingEngine":{ - "shape":"RenderingEngine", - "documentation":"The rendering engine for the simulation application.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision id of the simulation application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation application was last updated.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the specified simulation application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI used to create the simulation application.
" - }, - "imageDigest":{ - "shape":"ImageDigest", - "documentation":"A SHA256 identifier for the Docker image that you use for your simulation application.
" - } - } - }, - "DescribeSimulationJobBatchRequest":{ - "type":"structure", - "required":["batch"], - "members":{ - "batch":{ - "shape":"Arn", - "documentation":"The id of the batch to describe.
" - } - } - }, - "DescribeSimulationJobBatchResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the batch.
" - }, - "status":{ - "shape":"SimulationJobBatchStatus", - "documentation":"The status of the batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError
). See failureCode
and failureReason
for more information.
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example, Completed
or Failed
).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError
), the batch status will be Failed
. If there are no such failing request, the batch status will be TimedOut
.
The simulation batch job timed out.
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job batch was created.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "batchPolicy":{ - "shape":"BatchPolicy", - "documentation":"The batch policy.
" - }, - "failureCode":{ - "shape":"SimulationJobBatchErrorCode", - "documentation":"The failure code of the simulation job batch.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"The reason the simulation job batch failed.
" - }, - "failedRequests":{ - "shape":"FailedCreateSimulationJobRequests", - "documentation":"A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
" - }, - "pendingRequests":{ - "shape":"CreateSimulationJobRequests", - "documentation":"A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
" - }, - "createdRequests":{ - "shape":"SimulationJobSummaries", - "documentation":"A list of created simulation job summaries.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the simulation job batch.
" - } - } - }, - "DescribeSimulationJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation job to be described.
" - } - } - }, - "DescribeSimulationJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation job.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the simulation job.
" - }, - "status":{ - "shape":"SimulationJobStatus", - "documentation":"The status of the simulation job.
" - }, - "lastStartedAt":{ - "shape":"LastStartedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job was last started.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job was last updated.
" - }, - "failureBehavior":{ - "shape":"FailureBehavior", - "documentation":"The failure behavior for the simulation job.
" - }, - "failureCode":{ - "shape":"SimulationJobErrorCode", - "documentation":"The failure code of the simulation job if it failed:
Internal service error.
Robot application exited abnormally.
Simulation application exited abnormally.
Robot application bundle could not be downloaded.
Simulation application bundle could not be downloaded.
Unable to publish outputs to customer-provided S3 bucket.
Unable to publish logs to customer-provided CloudWatch Logs resource.
Subnet IP limit exceeded.
ENI limit exceeded.
Unable to use the Role provided.
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
Etag for RobotApplication does not match value during version creation.
Etag for SimulationApplication does not match value during version creation.
Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "outputLocation":{ - "shape":"OutputLocation", - "documentation":"Location for output files generated by the simulation job.
" - }, - "loggingConfig":{ - "shape":"LoggingConfig", - "documentation":"The logging configuration.
" - }, - "maxJobDurationInSeconds":{ - "shape":"JobDuration", - "documentation":"The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
" - }, - "simulationTimeMillis":{ - "shape":"SimulationTimeMillis", - "documentation":"The simulation job execution duration in milliseconds.
" - }, - "iamRole":{ - "shape":"IamRole", - "documentation":"The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
" - }, - "robotApplications":{ - "shape":"RobotApplicationConfigs", - "documentation":"A list of robot applications.
" - }, - "simulationApplications":{ - "shape":"SimulationApplicationConfigs", - "documentation":"A list of simulation applications.
" - }, - "dataSources":{ - "shape":"DataSources", - "documentation":"The data sources for the simulation job.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the specified simulation job.
" - }, - "vpcConfig":{ - "shape":"VPCConfigResponse", - "documentation":"The VPC configuration.
" - }, - "networkInterface":{ - "shape":"NetworkInterface", - "documentation":"The network interface information for the simulation job.
" - }, - "compute":{ - "shape":"ComputeResponse", - "documentation":"Compute information for the simulation job.
" - } - } - }, - "DescribeWorldExportJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world export job to describe.
" - } - } - }, - "DescribeWorldExportJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world export job.
" - }, - "status":{ - "shape":"WorldExportJobStatus", - "documentation":"The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode
and failureReason
for more information.
The world export job was cancelled.
The world export job is being cancelled.
The time, in milliseconds since the epoch, when the world export job was created.
" - }, - "failureCode":{ - "shape":"WorldExportJobErrorCode", - "documentation":"The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The reason why the world export job failed.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "worlds":{ - "shape":"Arns", - "documentation":"A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
" - }, - "outputLocation":{"shape":"OutputLocation"}, - "iamRole":{ - "shape":"IamRole", - "documentation":"The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world export job.
" - } - } - }, - "DescribeWorldGenerationJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world generation job to describe.
" - } - } - }, - "DescribeWorldGenerationJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world generation job.
" - }, - "status":{ - "shape":"WorldGenerationJobStatus", - "documentation":"The status of the world generation job:
The world generation job request is pending.
The world generation job is running.
The world generation job completed.
The world generation job failed. See failureCode
for more information.
Some worlds did not generate.
The world generation job was cancelled.
The world generation job is being cancelled.
The time, in milliseconds since the epoch, when the world generation job was created.
" - }, - "failureCode":{ - "shape":"WorldGenerationJobErrorCode", - "documentation":"The failure code of the world generation job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The reason why the world generation job failed.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template.
" - }, - "worldCount":{ - "shape":"WorldCount", - "documentation":"Information about the world count.
" - }, - "finishedWorldsSummary":{ - "shape":"FinishedWorldsSummary", - "documentation":"Summary information about finished worlds.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world generation job.
" - }, - "worldTags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the generated worlds.
" - } - } - }, - "DescribeWorldRequest":{ - "type":"structure", - "required":["world"], - "members":{ - "world":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world you want to describe.
" - } - } - }, - "DescribeWorldResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world.
" - }, - "generationJob":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world generation job that generated the world.
" - }, - "template":{ - "shape":"Arn", - "documentation":"The world template.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world was created.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world.
" - }, - "worldDescriptionBody":{ - "shape":"Json", - "documentation":"Returns the JSON formatted string that describes the contents of your world.
" - } - } - }, - "DescribeWorldTemplateRequest":{ - "type":"structure", - "required":["template"], - "members":{ - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template you want to describe.
" - } - } - }, - "DescribeWorldTemplateResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world template.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "name":{ - "shape":"TemplateName", - "documentation":"The name of the world template.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world template was created.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world template was last updated.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the world template.
" - }, - "version":{ - "shape":"GenericString", - "documentation":"The version of the world template that you're using.
" - } - } - }, - "Environment":{ - "type":"structure", - "members":{ - "uri":{ - "shape":"RepositoryUrl", - "documentation":"The Docker image URI for either your robot or simulation applications.
" - } - }, - "documentation":"The object that contains the Docker image URI for either your robot or simulation applications.
" - }, - "EnvironmentVariableKey":{ - "type":"string", - "max":1024, - "min":1, - "pattern":"[A-Z_][A-Z0-9_]*" - }, - "EnvironmentVariableMap":{ - "type":"map", - "key":{"shape":"EnvironmentVariableKey"}, - "value":{"shape":"EnvironmentVariableValue"}, - "max":20, - "min":0 - }, - "EnvironmentVariableValue":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*" - }, - "ExitBehavior":{ - "type":"string", - "enum":[ - "FAIL", - "RESTART" - ] - }, - "FailedAt":{"type":"timestamp"}, - "FailedCreateSimulationJobRequest":{ - "type":"structure", - "members":{ - "request":{ - "shape":"SimulationJobRequest", - "documentation":"The simulation job request.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"The failure reason of the simulation job request.
" - }, - "failureCode":{ - "shape":"SimulationJobErrorCode", - "documentation":"The failure code.
" - }, - "failedAt":{ - "shape":"FailedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job batch failed.
" - } - }, - "documentation":"Information about a failed create simulation job request.
" - }, - "FailedCreateSimulationJobRequests":{ - "type":"list", - "member":{"shape":"FailedCreateSimulationJobRequest"} - }, - "FailureBehavior":{ - "type":"string", - "enum":[ - "Fail", - "Continue" - ] - }, - "FailureSummary":{ - "type":"structure", - "members":{ - "totalFailureCount":{ - "shape":"Integer", - "documentation":"The total number of failures.
" - }, - "failures":{ - "shape":"WorldFailures", - "documentation":"The worlds that failed.
" - } - }, - "documentation":"Information about worlds that failed.
" - }, - "Filter":{ - "type":"structure", - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the filter.
" - }, - "values":{ - "shape":"FilterValues", - "documentation":"A list of values.
" - } - }, - "documentation":"Information about a filter.
" - }, - "FilterValues":{ - "type":"list", - "member":{"shape":"Name"}, - "max":1, - "min":1 - }, - "Filters":{ - "type":"list", - "member":{"shape":"Filter"}, - "max":1, - "min":1 - }, - "FinishedWorldsSummary":{ - "type":"structure", - "members":{ - "finishedCount":{ - "shape":"Integer", - "documentation":"The total number of finished worlds.
" - }, - "succeededWorlds":{ - "shape":"Arns", - "documentation":"A list of worlds that succeeded.
" - }, - "failureSummary":{ - "shape":"FailureSummary", - "documentation":"Information about worlds that failed.
" - } - }, - "documentation":"Information about worlds that finished.
" - }, - "Fleet":{ - "type":"structure", - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the fleet.
" - }, - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the fleet was created.
" - }, - "lastDeploymentStatus":{ - "shape":"DeploymentStatus", - "documentation":"The status of the last fleet deployment.
" - }, - "lastDeploymentJob":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the last deployment job.
" - }, - "lastDeploymentTime":{ - "shape":"CreatedAt", - "documentation":"The time of the last deployment.
" - } - }, - "documentation":"Information about a fleet.
" - }, - "Fleets":{ - "type":"list", - "member":{"shape":"Fleet"}, - "max":200, - "min":0 - }, - "FloorplanCount":{"type":"integer"}, - "GPUUnit":{ - "type":"integer", - "max":1, - "min":0 - }, - "GenericInteger":{"type":"integer"}, - "GenericString":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "GetWorldTemplateBodyRequest":{ - "type":"structure", - "members":{ - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template.
" - }, - "generationJob":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world generator job.
" - } - } - }, - "GetWorldTemplateBodyResponse":{ - "type":"structure", - "members":{ - "templateBody":{ - "shape":"Json", - "documentation":"The world template body.
" - } - } - }, - "IamRole":{ - "type":"string", - "max":255, - "min":1, - "pattern":"arn:aws:iam::\\w+:role/.*" - }, - "Id":{ - "type":"string", - "max":1224, - "min":1, - "pattern":".*" - }, - "IdempotentParameterMismatchException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "ImageDigest":{ - "type":"string", - "max":72, - "min":0, - "pattern":"[Ss][Hh][Aa]256:[0-9a-fA-F]{64}" - }, - "Integer":{"type":"integer"}, - "InteriorCountPerFloorplan":{"type":"integer"}, - "InternalServerException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"AWS RoboMaker experienced a service issue. Try your call again.
", - "error":{"httpStatusCode":500}, - "exception":true - }, - "InvalidParameterException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "JobDuration":{"type":"long"}, - "Json":{ - "type":"string", - "max":262144, - "min":1, - "pattern":"[\\S\\s]+" - }, - "LastStartedAt":{"type":"timestamp"}, - "LastUpdatedAt":{"type":"timestamp"}, - "LaunchConfig":{ - "type":"structure", - "members":{ - "packageName":{ - "shape":"Command", - "documentation":"The package name.
" - }, - "launchFile":{ - "shape":"Command", - "documentation":"The launch file name.
" - }, - "environmentVariables":{ - "shape":"EnvironmentVariableMap", - "documentation":"The environment variables for the application launch.
" - }, - "portForwardingConfig":{ - "shape":"PortForwardingConfig", - "documentation":"The port forwarding configuration.
" - }, - "streamUI":{ - "shape":"Boolean", - "documentation":"Boolean indicating whether a streaming session will be configured for the application. If True
, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
If you've specified General
as the value for your RobotSoftwareSuite
, you can use this field to specify a list of commands for your container image.
If you've specified SimulationRuntime
as the value for your SimulationSoftwareSuite
, you can use this field to specify a list of commands for your container image.
Information about a launch configuration.
" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "ListDeploymentJobsRequest":{ - "type":"structure", - "members":{ - "filters":{ - "shape":"Filters", - "documentation":"Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress
or the status Pending
.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListDeploymentJobs
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs
request with the returned nextToken
value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs
returns up to 200 results and a nextToken
value if applicable.
A list of deployment jobs that meet the criteria of the request.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListFleets
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
When this parameter is used, ListFleets
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListFleets
request with the returned nextToken
value. This value can be between 1 and 200. If this parameter is not used, then ListFleets
returns up to 200 results and a nextToken
value if applicable.
Optional filters to limit results.
The filter name name
is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
A list of fleet details meeting the request criteria.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListFleets
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
The version qualifier of the robot application.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListRobotApplications
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListRobotApplications
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications
returns up to 100 results and a nextToken
value if applicable.
Optional filters to limit results.
The filter name name
is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
A list of robot application summaries that meet the criteria of the request.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListRobots
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListRobots
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListRobots
request with the returned nextToken
value. This value can be between 1 and 200. If this parameter is not used, then ListRobots
returns up to 200 results and a nextToken
value if applicable.
Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered
or the status Available
.
A list of robots that meet the criteria of the request.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListRobots
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
The version qualifier of the simulation application.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListSimulationApplications
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications
returns up to 100 results and a nextToken
value if applicable.
Optional list of filters to limit results.
The filter name name
is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
A list of simulation application summaries that meet the criteria of the request.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListSimulationJobBatches
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListSimulationJobBatches
request with the returned nextToken
value.
Optional filters to limit results.
" - } - } - }, - "ListSimulationJobBatchesResponse":{ - "type":"structure", - "members":{ - "simulationJobBatchSummaries":{ - "shape":"SimulationJobBatchSummaries", - "documentation":"A list of simulation job batch summaries.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListSimulationJobs
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs
request with the returned nextToken
value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs
returns up to 1000 results and a nextToken
value if applicable.
Optional filters to limit results.
The filter names status
and simulationApplicationName
and robotApplicationName
are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing
or the status Running
.
A list of simulation job summaries that meet the criteria of the request.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"TagMap", - "documentation":"The list of all tags added to the specified resource.
" - } - } - }, - "ListWorldExportJobsRequest":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListWorldExportJobs
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs
returns up to 100 results and a nextToken
value if applicable.
Optional filters to limit results. You can use generationJobId
and templateId
.
Summary information for world export jobs.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListWorldGeneratorJobs
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs
returns up to 100 results and a nextToken
value if applicable.
Optional filters to limit results. You can use status
and templateId
.
Summary information for world generator jobs.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListWorldTemplates
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListWorldTemplates
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates
returns up to 100 results and a nextToken
value if applicable.
Summary information for templates.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorlds
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
When this parameter is used, ListWorlds
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListWorlds
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds
returns up to 100 results and a nextToken
value if applicable.
Optional filters to limit results. You can use status
.
Summary information for worlds.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"If the previous paginated request did not return all of the remaining results, the response object's nextToken
parameter value is set to a token. To retrieve the next set of results, call ListWorlds
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
A boolean indicating whether to record all ROS topics.
This API is no longer supported and will throw an error if used.
The logging configuration.
" - }, - "MaxConcurrency":{"type":"integer"}, - "MaxResults":{"type":"integer"}, - "Name":{ - "type":"string", - "max":255, - "min":1, - "pattern":"[a-zA-Z0-9_\\-]*" - }, - "NetworkInterface":{ - "type":"structure", - "members":{ - "networkInterfaceId":{ - "shape":"GenericString", - "documentation":"The ID of the network interface.
" - }, - "privateIpAddress":{ - "shape":"GenericString", - "documentation":"The IPv4 address of the network interface within the subnet.
" - }, - "publicIpAddress":{ - "shape":"GenericString", - "documentation":"The IPv4 public address of the network interface.
" - } - }, - "documentation":"Describes a network interface.
" - }, - "NonEmptyString":{ - "type":"string", - "max":255, - "min":1, - "pattern":".+" - }, - "NonSystemPort":{ - "type":"integer", - "max":65535, - "min":1024 - }, - "OutputLocation":{ - "type":"structure", - "members":{ - "s3Bucket":{ - "shape":"S3Bucket", - "documentation":"The S3 bucket for output.
" - }, - "s3Prefix":{ - "shape":"S3Key", - "documentation":"The S3 folder in the s3Bucket
where output files will be placed.
The output location.
" - }, - "PaginationToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"[a-zA-Z0-9_.\\-\\/+=]*" - }, - "Path":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*" - }, - "PercentDone":{ - "type":"float", - "max":100.0, - "min":0.0 - }, - "Percentage":{ - "type":"integer", - "max":100, - "min":1 - }, - "Port":{ - "type":"integer", - "max":65535, - "min":1 - }, - "PortForwardingConfig":{ - "type":"structure", - "members":{ - "portMappings":{ - "shape":"PortMappingList", - "documentation":"The port mappings for the configuration.
" - } - }, - "documentation":"Configuration information for port forwarding.
" - }, - "PortMapping":{ - "type":"structure", - "required":[ - "jobPort", - "applicationPort" - ], - "members":{ - "jobPort":{ - "shape":"Port", - "documentation":"The port number on the simulation job instance to use as a remote connection point.
" - }, - "applicationPort":{ - "shape":"NonSystemPort", - "documentation":"The port number on the application.
" - }, - "enableOnPublicIp":{ - "shape":"Boolean", - "documentation":"A Boolean indicating whether to enable this port mapping on public IP.
" - } - }, - "documentation":"An object representing a port mapping.
" - }, - "PortMappingList":{ - "type":"list", - "member":{"shape":"PortMapping"}, - "max":10, - "min":0 - }, - "ProgressDetail":{ - "type":"structure", - "members":{ - "currentProgress":{ - "shape":"RobotDeploymentStep", - "documentation":"The current progress status.
Validating the deployment.
Downloading and extracting the bundle on the robot.
Executing pre-launch script(s) if provided.
Launching the robot application.
Executing post-launch script(s) if provided.
Deployment is complete.
Precentage of the step that is done. This currently only applies to the Downloading/Extracting
step of the deployment. It is empty for other steps.
Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting
step of the deployment. It is empty for other steps.
The Amazon Resource Name (ARN) of the deployment job.
" - } - }, - "documentation":"Information about the progress of a deployment job.
" - }, - "RegisterRobotRequest":{ - "type":"structure", - "required":[ - "fleet", - "robot" - ], - "members":{ - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "robot":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "RegisterRobotResponse":{ - "type":"structure", - "members":{ - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet that the robot will join.
" - }, - "robot":{ - "shape":"Arn", - "documentation":"Information about the robot registration.
" - } - }, - "deprecated":true, - "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "RenderingEngine":{ - "type":"structure", - "members":{ - "name":{ - "shape":"RenderingEngineType", - "documentation":"The name of the rendering engine.
" - }, - "version":{ - "shape":"RenderingEngineVersionType", - "documentation":"The version of the rendering engine.
" - } - }, - "documentation":"Information about a rendering engine.
" - }, - "RenderingEngineType":{ - "type":"string", - "enum":["OGRE"] - }, - "RenderingEngineVersionType":{ - "type":"string", - "max":4, - "min":1, - "pattern":"1.x" - }, - "RepositoryUrl":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".+" - }, - "ResourceAlreadyExistsException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The specified resource already exists.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The specified resource does not exist.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "RestartSimulationJobRequest":{ - "type":"structure", - "required":["job"], - "members":{ - "job":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation job.
" - } - } - }, - "RestartSimulationJobResponse":{ - "type":"structure", - "members":{} - }, - "RevisionId":{ - "type":"string", - "max":40, - "min":1, - "pattern":"[a-zA-Z0-9_.\\-]*" - }, - "Robot":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the robot.
" - }, - "fleetArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "status":{ - "shape":"RobotStatus", - "documentation":"The status of the robot.
" - }, - "greenGrassGroupId":{ - "shape":"Id", - "documentation":"The Greengrass group associated with the robot.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot was created.
" - }, - "architecture":{ - "shape":"Architecture", - "documentation":"The architecture of the robot.
" - }, - "lastDeploymentJob":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the last deployment job.
" - }, - "lastDeploymentTime":{ - "shape":"CreatedAt", - "documentation":"The time of the last deployment.
" - } - }, - "documentation":"Information about a robot.
" - }, - "RobotApplicationConfig":{ - "type":"structure", - "required":[ - "application", - "launchConfig" - ], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the robot application.
" - }, - "applicationVersion":{ - "shape":"Version", - "documentation":"The version of the robot application.
" - }, - "launchConfig":{ - "shape":"LaunchConfig", - "documentation":"The launch configuration for the robot application.
" - }, - "uploadConfigurations":{ - "shape":"UploadConfigurations", - "documentation":"The upload configurations for the robot application.
" - }, - "useDefaultUploadConfigurations":{ - "shape":"BoxedBoolean", - "documentation":"A Boolean indicating whether to use default upload configurations. By default, .ros
and .gazebo
files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation
.
This API is no longer supported and will throw an error if used.
Information about tools configured for the robot application.
" - }, - "useDefaultTools":{ - "shape":"BoxedBoolean", - "documentation":"A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False
.
This API is no longer supported and will throw an error if used.
Application configuration information for a robot.
" - }, - "RobotApplicationConfigs":{ - "type":"list", - "member":{"shape":"RobotApplicationConfig"}, - "max":1, - "min":1 - }, - "RobotApplicationNames":{ - "type":"list", - "member":{"shape":"Name"} - }, - "RobotApplicationSummaries":{ - "type":"list", - "member":{"shape":"RobotApplicationSummary"}, - "max":100, - "min":0 - }, - "RobotApplicationSummary":{ - "type":"structure", - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the robot application.
" - }, - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the robot.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the robot application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot application was last updated.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"Information about a robot software suite.
" - } - }, - "documentation":"Summary information for a robot application.
" - }, - "RobotDeployment":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The robot deployment Amazon Resource Name (ARN).
" - }, - "deploymentStartTime":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the deployment was started.
" - }, - "deploymentFinishTime":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the deployment finished.
" - }, - "status":{ - "shape":"RobotStatus", - "documentation":"The status of the robot deployment.
" - }, - "progressDetail":{ - "shape":"ProgressDetail", - "documentation":"Information about how the deployment is progressing.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"A short description of the reason why the robot deployment failed.
" - }, - "failureCode":{ - "shape":"DeploymentJobErrorCode", - "documentation":"The robot deployment failure code.
" - } - }, - "documentation":"Information about a robot deployment.
" - }, - "RobotDeploymentStep":{ - "type":"string", - "enum":[ - "Validating", - "DownloadingExtracting", - "ExecutingDownloadCondition", - "ExecutingPreLaunch", - "Launching", - "ExecutingPostLaunch", - "Finished" - ] - }, - "RobotDeploymentSummary":{ - "type":"list", - "member":{"shape":"RobotDeployment"} - }, - "RobotSoftwareSuite":{ - "type":"structure", - "members":{ - "name":{ - "shape":"RobotSoftwareSuiteType", - "documentation":"The name of the robot software suite. General
is the only supported value.
The version of the robot software suite. Not applicable for General software suite.
" - } - }, - "documentation":"Information about a robot software suite.
" - }, - "RobotSoftwareSuiteType":{ - "type":"string", - "enum":[ - "ROS", - "ROS2", - "General" - ] - }, - "RobotSoftwareSuiteVersionType":{ - "type":"string", - "enum":[ - "Kinetic", - "Melodic", - "Dashing", - "Foxy" - ] - }, - "RobotStatus":{ - "type":"string", - "enum":[ - "Available", - "Registered", - "PendingNewDeployment", - "Deploying", - "Failed", - "InSync", - "NoResponse" - ] - }, - "Robots":{ - "type":"list", - "member":{"shape":"Robot"}, - "max":1000, - "min":0 - }, - "S3Bucket":{ - "type":"string", - "max":63, - "min":3, - "pattern":"[a-z0-9][a-z0-9.\\-]*[a-z0-9]" - }, - "S3Etag":{"type":"string"}, - "S3Etags":{ - "type":"list", - "member":{"shape":"S3Etag"} - }, - "S3Key":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*" - }, - "S3KeyOrPrefix":{ - "type":"string", - "max":1024, - "min":0, - "pattern":".*" - }, - "S3KeyOutput":{ - "type":"structure", - "members":{ - "s3Key":{ - "shape":"S3KeyOrPrefix", - "documentation":"The S3 key.
" - }, - "etag":{ - "shape":"S3Etag", - "documentation":"The etag for the object.
" - } - }, - "documentation":"Information about S3 keys.
" - }, - "S3KeyOutputs":{ - "type":"list", - "member":{"shape":"S3KeyOutput"} - }, - "S3KeysOrPrefixes":{ - "type":"list", - "member":{"shape":"S3KeyOrPrefix"}, - "max":100, - "min":1 - }, - "S3Object":{ - "type":"structure", - "required":[ - "bucket", - "key" - ], - "members":{ - "bucket":{ - "shape":"S3Bucket", - "documentation":"The bucket containing the object.
" - }, - "key":{ - "shape":"S3Key", - "documentation":"The key of the object.
" - }, - "etag":{ - "shape":"S3Etag", - "documentation":"The etag of the object.
" - } - }, - "documentation":"Information about an S3 object.
" - }, - "SecurityGroups":{ - "type":"list", - "member":{"shape":"NonEmptyString"}, - "max":5, - "min":1 - }, - "ServiceUnavailableException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The request has failed due to a temporary failure of the server.
", - "error":{"httpStatusCode":503}, - "exception":true - }, - "SimulationApplicationConfig":{ - "type":"structure", - "required":[ - "application", - "launchConfig" - ], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the simulation application.
" - }, - "applicationVersion":{ - "shape":"Version", - "documentation":"The version of the simulation application.
" - }, - "launchConfig":{ - "shape":"LaunchConfig", - "documentation":"The launch configuration for the simulation application.
" - }, - "uploadConfigurations":{ - "shape":"UploadConfigurations", - "documentation":"Information about upload configurations for the simulation application.
" - }, - "worldConfigs":{ - "shape":"WorldConfigs", - "documentation":"A list of world configurations.
This API is no longer supported and will throw an error if used.
A Boolean indicating whether to use default upload configurations. By default, .ros
and .gazebo
files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation
.
This API is no longer supported and will throw an error if used.
Information about tools configured for the simulation application.
" - }, - "useDefaultTools":{ - "shape":"BoxedBoolean", - "documentation":"A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False
.
This API is no longer supported and will throw an error if used.
Information about a simulation application configuration.
" - }, - "SimulationApplicationConfigs":{ - "type":"list", - "member":{"shape":"SimulationApplicationConfig"}, - "max":1, - "min":1 - }, - "SimulationApplicationNames":{ - "type":"list", - "member":{"shape":"Name"} - }, - "SimulationApplicationSummaries":{ - "type":"list", - "member":{"shape":"SimulationApplicationSummary"}, - "max":100, - "min":0 - }, - "SimulationApplicationSummary":{ - "type":"structure", - "members":{ - "name":{ - "shape":"Name", - "documentation":"The name of the simulation application.
" - }, - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the simulation application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation application was last updated.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"Information about a robot software suite.
" - }, - "simulationSoftwareSuite":{ - "shape":"SimulationSoftwareSuite", - "documentation":"Information about a simulation software suite.
" - } - }, - "documentation":"Summary information for a simulation application.
" - }, - "SimulationJob":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation job.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the simulation job.
" - }, - "status":{ - "shape":"SimulationJobStatus", - "documentation":"Status of the simulation job.
" - }, - "lastStartedAt":{ - "shape":"LastStartedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job was last started.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job was last updated.
" - }, - "failureBehavior":{ - "shape":"FailureBehavior", - "documentation":"The failure behavior the simulation job.
Leaves the host running for its maximum timeout duration after a 4XX
error code.
Stop the simulation job and terminate the instance.
The failure code of the simulation job if it failed.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"The reason why the simulation job failed.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"A unique identifier for this SimulationJob
request.
Location for output files generated by the simulation job.
" - }, - "loggingConfig":{ - "shape":"LoggingConfig", - "documentation":"The logging configuration.
" - }, - "maxJobDurationInSeconds":{ - "shape":"JobDuration", - "documentation":"The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
" - }, - "simulationTimeMillis":{ - "shape":"SimulationTimeMillis", - "documentation":"The simulation job execution duration in milliseconds.
" - }, - "iamRole":{ - "shape":"IamRole", - "documentation":"The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
" - }, - "robotApplications":{ - "shape":"RobotApplicationConfigs", - "documentation":"A list of robot applications.
" - }, - "simulationApplications":{ - "shape":"SimulationApplicationConfigs", - "documentation":"A list of simulation applications.
" - }, - "dataSources":{ - "shape":"DataSources", - "documentation":"The data sources for the simulation job.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the simulation job.
" - }, - "vpcConfig":{ - "shape":"VPCConfigResponse", - "documentation":"VPC configuration information.
" - }, - "networkInterface":{ - "shape":"NetworkInterface", - "documentation":"Information about a network interface.
" - }, - "compute":{ - "shape":"ComputeResponse", - "documentation":"Compute information for the simulation job
" - } - }, - "documentation":"Information about a simulation job.
" - }, - "SimulationJobBatchErrorCode":{ - "type":"string", - "enum":["InternalServiceError"] - }, - "SimulationJobBatchStatus":{ - "type":"string", - "enum":[ - "Pending", - "InProgress", - "Failed", - "Completed", - "Canceled", - "Canceling", - "Completing", - "TimingOut", - "TimedOut" - ] - }, - "SimulationJobBatchSummaries":{ - "type":"list", - "member":{"shape":"SimulationJobBatchSummary"} - }, - "SimulationJobBatchSummary":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the batch.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job batch was last updated.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job batch was created.
" - }, - "status":{ - "shape":"SimulationJobBatchStatus", - "documentation":"The status of the simulation job batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError
). See failureCode
and failureReason
for more information.
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example, Completed
or Failed
).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError
), the batch status will be Failed
. If there are no such failing request, the batch status will be TimedOut
.
The simulation batch job timed out.
The number of failed simulation job requests.
" - }, - "pendingRequestCount":{ - "shape":"Integer", - "documentation":"The number of pending simulation job requests.
" - }, - "createdRequestCount":{ - "shape":"Integer", - "documentation":"The number of created simulation job requests.
" - } - }, - "documentation":"Information about a simulation job batch.
" - }, - "SimulationJobErrorCode":{ - "type":"string", - "enum":[ - "InternalServiceError", - "RobotApplicationCrash", - "SimulationApplicationCrash", - "RobotApplicationHealthCheckFailure", - "SimulationApplicationHealthCheckFailure", - "BadPermissionsRobotApplication", - "BadPermissionsSimulationApplication", - "BadPermissionsS3Object", - "BadPermissionsS3Output", - "BadPermissionsCloudwatchLogs", - "SubnetIpLimitExceeded", - "ENILimitExceeded", - "BadPermissionsUserCredentials", - "InvalidBundleRobotApplication", - "InvalidBundleSimulationApplication", - "InvalidS3Resource", - "ThrottlingError", - "LimitExceeded", - "MismatchedEtag", - "RobotApplicationVersionMismatchedEtag", - "SimulationApplicationVersionMismatchedEtag", - "ResourceNotFound", - "RequestThrottled", - "BatchTimedOut", - "BatchCanceled", - "InvalidInput", - "WrongRegionS3Bucket", - "WrongRegionS3Output", - "WrongRegionRobotApplication", - "WrongRegionSimulationApplication", - "UploadContentMismatchError" - ] - }, - "SimulationJobRequest":{ - "type":"structure", - "required":["maxJobDurationInSeconds"], - "members":{ - "outputLocation":{"shape":"OutputLocation"}, - "loggingConfig":{"shape":"LoggingConfig"}, - "maxJobDurationInSeconds":{ - "shape":"JobDuration", - "documentation":"The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
" - }, - "iamRole":{ - "shape":"IamRole", - "documentation":"The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
" - }, - "failureBehavior":{ - "shape":"FailureBehavior", - "documentation":"The failure behavior the simulation job.
Leaves the host running for its maximum timeout duration after a 4XX
error code.
Stop the simulation job and terminate the instance.
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
" - }, - "robotApplications":{ - "shape":"RobotApplicationConfigs", - "documentation":"The robot applications to use in the simulation job.
" - }, - "simulationApplications":{ - "shape":"SimulationApplicationConfigs", - "documentation":"The simulation applications to use in the simulation job.
" - }, - "dataSources":{ - "shape":"DataSourceConfigs", - "documentation":"Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name
.
There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig
objects.
Compute information for the simulation job
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the simulation job request.
" - } - }, - "documentation":"Information about a simulation job request.
" - }, - "SimulationJobStatus":{ - "type":"string", - "enum":[ - "Pending", - "Preparing", - "Running", - "Restarting", - "Completed", - "Failed", - "RunningFailed", - "Terminating", - "Terminated", - "Canceled" - ] - }, - "SimulationJobSummaries":{ - "type":"list", - "member":{"shape":"SimulationJobSummary"}, - "max":100, - "min":0 - }, - "SimulationJobSummary":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the simulation job.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job was last updated.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the simulation job.
" - }, - "status":{ - "shape":"SimulationJobStatus", - "documentation":"The status of the simulation job.
" - }, - "simulationApplicationNames":{ - "shape":"SimulationApplicationNames", - "documentation":"A list of simulation job simulation application names.
" - }, - "robotApplicationNames":{ - "shape":"RobotApplicationNames", - "documentation":"A list of simulation job robot application names.
" - }, - "dataSourceNames":{ - "shape":"DataSourceNames", - "documentation":"The names of the data sources.
" - }, - "computeType":{ - "shape":"ComputeType", - "documentation":"The compute type for the simulation job summary.
" - } - }, - "documentation":"Summary information for a simulation job.
" - }, - "SimulationJobs":{ - "type":"list", - "member":{"shape":"SimulationJob"} - }, - "SimulationSoftwareSuite":{ - "type":"structure", - "members":{ - "name":{ - "shape":"SimulationSoftwareSuiteType", - "documentation":"The name of the simulation software suite. SimulationRuntime
is the only supported value.
The version of the simulation software suite. Not applicable for SimulationRuntime
.
Information about a simulation software suite.
" - }, - "SimulationSoftwareSuiteType":{ - "type":"string", - "enum":[ - "Gazebo", - "RosbagPlay", - "SimulationRuntime" - ] - }, - "SimulationSoftwareSuiteVersionType":{ - "type":"string", - "max":1024, - "min":0, - "pattern":"7|9|11|Kinetic|Melodic|Dashing|Foxy" - }, - "SimulationTimeMillis":{"type":"long"}, - "SimulationUnit":{ - "type":"integer", - "max":15, - "min":1 - }, - "Source":{ - "type":"structure", - "members":{ - "s3Bucket":{ - "shape":"S3Bucket", - "documentation":"The s3 bucket name.
" - }, - "s3Key":{ - "shape":"S3Key", - "documentation":"The s3 object key.
" - }, - "etag":{ - "shape":"S3Etag", - "documentation":"A hash of the object specified by s3Bucket
and s3Key
.
The taget processor architecture for the application.
" - } - }, - "documentation":"Information about a source.
" - }, - "SourceConfig":{ - "type":"structure", - "members":{ - "s3Bucket":{ - "shape":"S3Bucket", - "documentation":"The Amazon S3 bucket name.
" - }, - "s3Key":{ - "shape":"S3Key", - "documentation":"The s3 object key.
" - }, - "architecture":{ - "shape":"Architecture", - "documentation":"The target processor architecture for the application.
" - } - }, - "documentation":"Information about a source configuration.
" - }, - "SourceConfigs":{ - "type":"list", - "member":{"shape":"SourceConfig"} - }, - "Sources":{ - "type":"list", - "member":{"shape":"Source"} - }, - "StartSimulationJobBatchRequest":{ - "type":"structure", - "required":["createSimulationJobRequests"], - "members":{ - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "idempotencyToken":true - }, - "batchPolicy":{ - "shape":"BatchPolicy", - "documentation":"The batch policy.
" - }, - "createSimulationJobRequests":{ - "shape":"CreateSimulationJobRequests", - "documentation":"A list of simulation job requests to create in the batch.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the deployment job batch.
" - } - } - }, - "StartSimulationJobBatchResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the batch.
" - }, - "status":{ - "shape":"SimulationJobBatchStatus", - "documentation":"The status of the simulation job batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError
). See failureCode
and failureReason
for more information.
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example, Completed
or Failed
).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError
), the batch status will be Failed
. If there are no such failing request, the batch status will be TimedOut
.
The simulation batch job timed out.
The time, in milliseconds since the epoch, when the simulation job batch was created.
" - }, - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" - }, - "batchPolicy":{ - "shape":"BatchPolicy", - "documentation":"The batch policy.
" - }, - "failureCode":{ - "shape":"SimulationJobBatchErrorCode", - "documentation":"The failure code if the simulation job batch failed.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"The reason the simulation job batch failed.
" - }, - "failedRequests":{ - "shape":"FailedCreateSimulationJobRequests", - "documentation":"A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
" - }, - "pendingRequests":{ - "shape":"CreateSimulationJobRequests", - "documentation":"A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
" - }, - "createdRequests":{ - "shape":"SimulationJobSummaries", - "documentation":"A list of created simulation job request summaries.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the deployment job batch.
" - } - } - }, - "Subnets":{ - "type":"list", - "member":{"shape":"NonEmptyString"}, - "max":16, - "min":1 - }, - "SyncDeploymentJobRequest":{ - "type":"structure", - "required":[ - "clientRequestToken", - "fleet" - ], - "members":{ - "clientRequestToken":{ - "shape":"ClientRequestToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "idempotencyToken":true - }, - "fleet":{ - "shape":"Arn", - "documentation":"The target fleet for the synchronization.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "SyncDeploymentJobResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the synchronization request.
" - }, - "fleet":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the fleet.
" - }, - "status":{ - "shape":"DeploymentStatus", - "documentation":"The status of the synchronization job.
" - }, - "deploymentConfig":{ - "shape":"DeploymentConfig", - "documentation":"Information about the deployment configuration.
" - }, - "deploymentApplicationConfigs":{ - "shape":"DeploymentApplicationConfigs", - "documentation":"Information about the deployment application configurations.
" - }, - "failureReason":{ - "shape":"GenericString", - "documentation":"The failure reason if the job fails.
" - }, - "failureCode":{ - "shape":"DeploymentJobErrorCode", - "documentation":"The failure code if the job fails:
Internal service error.
Robot application exited abnormally.
Simulation application exited abnormally.
Robot application bundle could not be downloaded.
Simulation application bundle could not be downloaded.
Unable to publish outputs to customer-provided S3 bucket.
Unable to publish logs to customer-provided CloudWatch Logs resource.
Subnet IP limit exceeded.
ENI limit exceeded.
Unable to use the Role provided.
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
Etag for RobotApplication does not match value during version creation.
Etag for SimulationApplication does not match value during version creation.
The time, in milliseconds since the epoch, when the fleet was created.
" - } - }, - "deprecated":true, - "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"[a-zA-Z0-9 _.\\-\\/+=:]*" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map that contains tag keys and tag values that are attached to the resource.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"[a-zA-Z0-9 _.\\-\\/+=:]*" - }, - "TemplateLocation":{ - "type":"structure", - "required":[ - "s3Bucket", - "s3Key" - ], - "members":{ - "s3Bucket":{ - "shape":"S3Bucket", - "documentation":"The Amazon S3 bucket name.
" - }, - "s3Key":{ - "shape":"S3Key", - "documentation":"The list of S3 keys identifying the data source files.
" - } - }, - "documentation":"Information about a template location.
" - }, - "TemplateName":{ - "type":"string", - "max":255, - "min":0, - "pattern":".*" - }, - "TemplateSummaries":{ - "type":"list", - "member":{"shape":"TemplateSummary"} - }, - "TemplateSummary":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the template.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the template was created.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the template was last updated.
" - }, - "name":{ - "shape":"TemplateName", - "documentation":"The name of the template.
" - }, - "version":{ - "shape":"GenericString", - "documentation":"The version of the template that you're using.
" - } - }, - "documentation":"Summary information for a template.
" - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"AWS RoboMaker is temporarily unable to process the request. Try your call again.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "Tool":{ - "type":"structure", - "required":[ - "name", - "command" - ], - "members":{ - "streamUI":{ - "shape":"BoxedBoolean", - "documentation":"Boolean indicating whether a streaming session will be configured for the tool. If True
, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False
.
The name of the tool.
" - }, - "command":{ - "shape":"UnrestrictedCommand", - "documentation":"Command-line arguments for the tool. It must include the tool executable name.
" - }, - "streamOutputToCloudWatch":{ - "shape":"BoxedBoolean", - "documentation":"Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False
.
Exit behavior determines what happens when your tool quits running. RESTART
will cause your tool to be restarted. FAIL
will cause your job to exit. The default is RESTART
.
Information about a tool. Tools are used in a simulation job.
" - }, - "Tools":{ - "type":"list", - "member":{"shape":"Tool"}, - "max":10, - "min":0 - }, - "UnrestrictedCommand":{ - "type":"string", - "max":1024, - "min":1, - "pattern":".*" - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "documentation":"A map that contains tag keys and tag values that will be unattached from the resource.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateRobotApplicationRequest":{ - "type":"structure", - "required":[ - "application", - "robotSoftwareSuite" - ], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the robot application.
" - }, - "sources":{ - "shape":"SourceConfigs", - "documentation":"The sources of the robot application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite used by the robot application.
" - }, - "currentRevisionId":{ - "shape":"RevisionId", - "documentation":"The revision id for the robot application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI for your robot application.
" - } - } - }, - "UpdateRobotApplicationResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the updated robot application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the robot application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the robot application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the robot application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite used by the robot application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the robot application was last updated.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision id of the robot application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI for your robot application.
" - } - } - }, - "UpdateSimulationApplicationRequest":{ - "type":"structure", - "required":[ - "application", - "simulationSoftwareSuite", - "robotSoftwareSuite" - ], - "members":{ - "application":{ - "shape":"Arn", - "documentation":"The application information for the simulation application.
" - }, - "sources":{ - "shape":"SourceConfigs", - "documentation":"The sources of the simulation application.
" - }, - "simulationSoftwareSuite":{ - "shape":"SimulationSoftwareSuite", - "documentation":"The simulation software suite used by the simulation application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite.
" - }, - "renderingEngine":{ - "shape":"RenderingEngine", - "documentation":"The rendering engine for the simulation application.
" - }, - "currentRevisionId":{ - "shape":"RevisionId", - "documentation":"The revision id for the robot application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI for your simulation application.
" - } - } - }, - "UpdateSimulationApplicationResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the updated simulation application.
" - }, - "name":{ - "shape":"Name", - "documentation":"The name of the simulation application.
" - }, - "version":{ - "shape":"Version", - "documentation":"The version of the robot application.
" - }, - "sources":{ - "shape":"Sources", - "documentation":"The sources of the simulation application.
" - }, - "simulationSoftwareSuite":{ - "shape":"SimulationSoftwareSuite", - "documentation":"The simulation software suite used by the simulation application.
" - }, - "robotSoftwareSuite":{ - "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite.
" - }, - "renderingEngine":{ - "shape":"RenderingEngine", - "documentation":"The rendering engine for the simulation application.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation application was last updated.
" - }, - "revisionId":{ - "shape":"RevisionId", - "documentation":"The revision id of the simulation application.
" - }, - "environment":{ - "shape":"Environment", - "documentation":"The object that contains the Docker image URI used for your simulation application.
" - } - } - }, - "UpdateWorldTemplateRequest":{ - "type":"structure", - "required":["template"], - "members":{ - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template to update.
" - }, - "name":{ - "shape":"TemplateName", - "documentation":"The name of the template.
" - }, - "templateBody":{ - "shape":"Json", - "documentation":"The world template body.
" - }, - "templateLocation":{ - "shape":"TemplateLocation", - "documentation":"The location of the world template.
" - } - } - }, - "UpdateWorldTemplateResponse":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template.
" - }, - "name":{ - "shape":"TemplateName", - "documentation":"The name of the world template.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world template was created.
" - }, - "lastUpdatedAt":{ - "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world template was last updated.
" - } - } - }, - "UploadBehavior":{ - "type":"string", - "enum":[ - "UPLOAD_ON_TERMINATE", - "UPLOAD_ROLLING_AUTO_REMOVE" - ] - }, - "UploadConfiguration":{ - "type":"structure", - "required":[ - "name", - "path", - "uploadBehavior" - ], - "members":{ - "name":{ - "shape":"Name", - "documentation":"A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://amzn-s3-demo-bucket
and your upload configuration name is robot-test
, your files will be uploaded to s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test
.
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of **
as a super asterisk. For example, specifying /var/log/**.log
causes all .log files in the /var/log
directory tree to be collected. For more examples, see Glob Library.
Specifies when to upload the files:
Matching files are uploaded once the simulation enters the TERMINATING
state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
" - }, - "UploadConfigurations":{ - "type":"list", - "member":{"shape":"UploadConfiguration"}, - "max":10, - "min":0 - }, - "VPCConfig":{ - "type":"structure", - "required":["subnets"], - "members":{ - "subnets":{ - "shape":"Subnets", - "documentation":"A list of one or more subnet IDs in your VPC.
" - }, - "securityGroups":{ - "shape":"SecurityGroups", - "documentation":"A list of one or more security groups IDs in your VPC.
" - }, - "assignPublicIp":{ - "shape":"Boolean", - "documentation":"A boolean indicating whether to assign a public IP address.
" - } - }, - "documentation":"If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.
" - }, - "VPCConfigResponse":{ - "type":"structure", - "members":{ - "subnets":{ - "shape":"Subnets", - "documentation":"A list of subnet IDs associated with the simulation job.
" - }, - "securityGroups":{ - "shape":"SecurityGroups", - "documentation":"A list of security group IDs associated with the simulation job.
" - }, - "vpcId":{ - "shape":"GenericString", - "documentation":"The VPC ID associated with your simulation job.
" - }, - "assignPublicIp":{ - "shape":"Boolean", - "documentation":"A boolean indicating if a public IP was assigned.
" - } - }, - "documentation":"VPC configuration associated with your simulation job.
" - }, - "Version":{ - "type":"string", - "max":255, - "min":1, - "pattern":"(\\$LATEST)|[0-9]*" - }, - "VersionQualifier":{ - "type":"string", - "max":255, - "min":1, - "pattern":"ALL" - }, - "WorldConfig":{ - "type":"structure", - "members":{ - "world":{ - "shape":"Arn", - "documentation":"The world generated by Simulation WorldForge.
" - } - }, - "documentation":"Configuration information for a world.
" - }, - "WorldConfigs":{ - "type":"list", - "member":{"shape":"WorldConfig"}, - "max":1, - "min":0 - }, - "WorldCount":{ - "type":"structure", - "members":{ - "floorplanCount":{ - "shape":"FloorplanCount", - "documentation":"The number of unique floorplans.
" - }, - "interiorCountPerFloorplan":{ - "shape":"InteriorCountPerFloorplan", - "documentation":"The number of unique interiors per floorplan.
" - } - }, - "documentation":"The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set floorplanCount = 1
and interiorCountPerFloorplan = 20
. This will result in 20 worlds (floorplanCount
* interiorCountPerFloorplan)
.
If you set floorplanCount = 4
and interiorCountPerFloorplan = 5
, there will be 20 worlds with 5 unique floor plans.
The Amazon Resource Name (ARN) of the world export job.
" - }, - "status":{ - "shape":"WorldExportJobStatus", - "documentation":"The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode
for more information.
The world export job was cancelled.
The world export job is being cancelled.
The time, in milliseconds since the epoch, when the world export job was created.
" - }, - "worlds":{ - "shape":"Arns", - "documentation":"A list of worlds.
" - }, - "outputLocation":{"shape":"OutputLocation"} - }, - "documentation":"Information about a world export job.
" - }, - "WorldFailure":{ - "type":"structure", - "members":{ - "failureCode":{ - "shape":"WorldGenerationJobErrorCode", - "documentation":"The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason
.
The number of failed worlds.
" - } - }, - "documentation":"Information about a failed world.
" - }, - "WorldFailures":{ - "type":"list", - "member":{"shape":"WorldFailure"}, - "max":100, - "min":0 - }, - "WorldGenerationJobErrorCode":{ - "type":"string", - "enum":[ - "InternalServiceError", - "LimitExceeded", - "ResourceNotFound", - "RequestThrottled", - "InvalidInput", - "AllWorldGenerationFailed" - ] - }, - "WorldGenerationJobStatus":{ - "type":"string", - "enum":[ - "Pending", - "Running", - "Completed", - "Failed", - "PartialFailed", - "Canceling", - "Canceled" - ] - }, - "WorldGenerationJobSummaries":{ - "type":"list", - "member":{"shape":"WorldGenerationJobSummary"}, - "max":100, - "min":0 - }, - "WorldGenerationJobSummary":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world generator job.
" - }, - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world generator job was created.
" - }, - "status":{ - "shape":"WorldGenerationJobStatus", - "documentation":"The status of the world generator job:
The world generator job request is pending.
The world generator job is running.
The world generator job completed.
The world generator job failed. See failureCode
for more information.
Some worlds did not generate.
The world generator job was cancelled.
The world generator job is being cancelled.
Information about the world count.
" - }, - "succeededWorldCount":{ - "shape":"Integer", - "documentation":"The number of worlds that were generated.
" - }, - "failedWorldCount":{ - "shape":"Integer", - "documentation":"The number of worlds that failed.
" - } - }, - "documentation":"Information about a world generator job.
" - }, - "WorldSummaries":{ - "type":"list", - "member":{"shape":"WorldSummary"} - }, - "WorldSummary":{ - "type":"structure", - "members":{ - "arn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the world.
" - }, - "createdAt":{ - "shape":"CreatedAt", - "documentation":"The time, in milliseconds since the epoch, when the world was created.
" - }, - "generationJob":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world generation job.
" - }, - "template":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (arn) of the world template.
" - } - }, - "documentation":"Information about a world.
" - }, - "errorMessage":{"type":"string"} - }, - "documentation":"This section provides documentation for the AWS RoboMaker API operations.
" -} diff --git a/awscli/botocore/data/waf/2015-08-24/completions-1.json b/awscli/botocore/data/waf/2015-08-24/completions-1.json deleted file mode 100644 index 482a6ed668c7..000000000000 --- a/awscli/botocore/data/waf/2015-08-24/completions-1.json +++ /dev/null @@ -1,563 +0,0 @@ -{ - "version": "1.0", - "resources": { - "ByteMatchSet": { - "operation": "ListByteMatchSets", - "resourceIdentifier": { - "ByteMatchSetId": "ByteMatchSets[].ByteMatchSetId" - } - }, - "GeoMatchSet": { - "operation": "ListGeoMatchSets", - "resourceIdentifier": { - "GeoMatchSetId": "GeoMatchSets[].GeoMatchSetId" - } - }, - "IPSet": { - "operation": "ListIPSets", - "resourceIdentifier": { - "IPSetId": "IPSets[].IPSetId" - } - }, - "LoggingConfiguration": { - "operation": "ListLoggingConfigurations", - "resourceIdentifier": { - "ResourceArn": "LoggingConfigurations[].ResourceArn" - } - }, - "RegexMatchSet": { - "operation": "ListRegexMatchSets", - "resourceIdentifier": { - "RegexMatchSetId": "RegexMatchSets[].RegexMatchSetId" - } - }, - "RegexPatternSet": { - "operation": "ListRegexPatternSets", - "resourceIdentifier": { - "RegexPatternSetId": "RegexPatternSets[].RegexPatternSetId" - } - }, - "Rule": { - "operation": "ListRules", - "resourceIdentifier": { - "RuleId": "Rules[].RuleId" - } - }, - "SizeConstraintSet": { - "operation": "ListSizeConstraintSets", - "resourceIdentifier": { - "SizeConstraintSetId": "SizeConstraintSets[].SizeConstraintSetId" - } - }, - "SqlInjectionMatchSet": { - "operation": "ListSqlInjectionMatchSets", - "resourceIdentifier": { - "SqlInjectionMatchSetId": "SqlInjectionMatchSets[].SqlInjectionMatchSetId" - } - }, - "SubscribedRuleGroup": { - "operation": "ListSubscribedRuleGroups", - "resourceIdentifier": { - "RuleGroupId": "RuleGroups[].RuleGroupId" - } - }, - "WebACL": { - "operation": "ListWebACLs", - "resourceIdentifier": { - "WebACLId": "WebACLs[].WebACLId" - } - }, - "XssMatchSet": { - "operation": "ListXssMatchSets", - "resourceIdentifier": { - "XssMatchSetId": "XssMatchSets[].XssMatchSetId" - } - } - }, - "operations": { - "DeleteByteMatchSet": { - "ByteMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ByteMatchSet", - "resourceIdentifier": "ByteMatchSetId" - } - ] - } - }, - "DeleteGeoMatchSet": { - "GeoMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "GeoMatchSet", - "resourceIdentifier": "GeoMatchSetId" - } - ] - } - }, - "DeleteIPSet": { - "IPSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "IPSet", - "resourceIdentifier": "IPSetId" - } - ] - } - }, - "DeleteLoggingConfiguration": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "LoggingConfiguration", - "resourceIdentifier": "ResourceArn" - } - ] - } - }, - "DeletePermissionPolicy": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "LoggingConfiguration", - "resourceIdentifier": "ResourceArn" - } - ] - } - }, - "DeleteRateBasedRule": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "DeleteRegexMatchSet": { - "RegexMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "RegexMatchSet", - "resourceIdentifier": "RegexMatchSetId" - } - ] - } - }, - "DeleteRegexPatternSet": { - "RegexPatternSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "RegexPatternSet", - "resourceIdentifier": "RegexPatternSetId" - } - ] - } - }, - "DeleteRule": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "DeleteRuleGroup": { - "RuleGroupId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SubscribedRuleGroup", - "resourceIdentifier": "RuleGroupId" - } - ] - } - }, - "DeleteSizeConstraintSet": { - "SizeConstraintSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SizeConstraintSet", - "resourceIdentifier": "SizeConstraintSetId" - } - ] - } - }, - "DeleteSqlInjectionMatchSet": { - "SqlInjectionMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SqlInjectionMatchSet", - "resourceIdentifier": "SqlInjectionMatchSetId" - } - ] - } - }, - "DeleteWebACL": { - "WebACLId": { - "completions": [ - { - "parameters": {}, - "resourceName": "WebACL", - "resourceIdentifier": "WebACLId" - } - ] - } - }, - "DeleteXssMatchSet": { - "XssMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "XssMatchSet", - "resourceIdentifier": "XssMatchSetId" - } - ] - } - }, - "GetByteMatchSet": { - "ByteMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ByteMatchSet", - "resourceIdentifier": "ByteMatchSetId" - } - ] - } - }, - "GetGeoMatchSet": { - "GeoMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "GeoMatchSet", - "resourceIdentifier": "GeoMatchSetId" - } - ] - } - }, - "GetIPSet": { - "IPSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "IPSet", - "resourceIdentifier": "IPSetId" - } - ] - } - }, - "GetLoggingConfiguration": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "LoggingConfiguration", - "resourceIdentifier": "ResourceArn" - } - ] - } - }, - "GetPermissionPolicy": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "LoggingConfiguration", - "resourceIdentifier": "ResourceArn" - } - ] - } - }, - "GetRateBasedRule": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "GetRateBasedRuleManagedKeys": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "GetRegexMatchSet": { - "RegexMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "RegexMatchSet", - "resourceIdentifier": "RegexMatchSetId" - } - ] - } - }, - "GetRegexPatternSet": { - "RegexPatternSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "RegexPatternSet", - "resourceIdentifier": "RegexPatternSetId" - } - ] - } - }, - "GetRule": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "GetRuleGroup": { - "RuleGroupId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SubscribedRuleGroup", - "resourceIdentifier": "RuleGroupId" - } - ] - } - }, - "GetSampledRequests": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "GetSizeConstraintSet": { - "SizeConstraintSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SizeConstraintSet", - "resourceIdentifier": "SizeConstraintSetId" - } - ] - } - }, - "GetSqlInjectionMatchSet": { - "SqlInjectionMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SqlInjectionMatchSet", - "resourceIdentifier": "SqlInjectionMatchSetId" - } - ] - } - }, - "GetWebACL": { - "WebACLId": { - "completions": [ - { - "parameters": {}, - "resourceName": "WebACL", - "resourceIdentifier": "WebACLId" - } - ] - } - }, - "GetXssMatchSet": { - "XssMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "XssMatchSet", - "resourceIdentifier": "XssMatchSetId" - } - ] - } - }, - "ListActivatedRulesInRuleGroup": { - "RuleGroupId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SubscribedRuleGroup", - "resourceIdentifier": "RuleGroupId" - } - ] - } - }, - "PutPermissionPolicy": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "LoggingConfiguration", - "resourceIdentifier": "ResourceArn" - } - ] - } - }, - "UpdateByteMatchSet": { - "ByteMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ByteMatchSet", - "resourceIdentifier": "ByteMatchSetId" - } - ] - } - }, - "UpdateGeoMatchSet": { - "GeoMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "GeoMatchSet", - "resourceIdentifier": "GeoMatchSetId" - } - ] - } - }, - "UpdateIPSet": { - "IPSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "IPSet", - "resourceIdentifier": "IPSetId" - } - ] - } - }, - "UpdateRateBasedRule": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "UpdateRegexMatchSet": { - "RegexMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "RegexMatchSet", - "resourceIdentifier": "RegexMatchSetId" - } - ] - } - }, - "UpdateRegexPatternSet": { - "RegexPatternSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "RegexPatternSet", - "resourceIdentifier": "RegexPatternSetId" - } - ] - } - }, - "UpdateRule": { - "RuleId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Rule", - "resourceIdentifier": "RuleId" - } - ] - } - }, - "UpdateRuleGroup": { - "RuleGroupId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SubscribedRuleGroup", - "resourceIdentifier": "RuleGroupId" - } - ] - } - }, - "UpdateSizeConstraintSet": { - "SizeConstraintSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SizeConstraintSet", - "resourceIdentifier": "SizeConstraintSetId" - } - ] - } - }, - "UpdateSqlInjectionMatchSet": { - "SqlInjectionMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "SqlInjectionMatchSet", - "resourceIdentifier": "SqlInjectionMatchSetId" - } - ] - } - }, - "UpdateWebACL": { - "WebACLId": { - "completions": [ - { - "parameters": {}, - "resourceName": "WebACL", - "resourceIdentifier": "WebACLId" - } - ] - } - }, - "UpdateXssMatchSet": { - "XssMatchSetId": { - "completions": [ - { - "parameters": {}, - "resourceName": "XssMatchSet", - "resourceIdentifier": "XssMatchSetId" - } - ] - } - } - } -} diff --git a/awscli/botocore/data/waf/2015-08-24/endpoint-rule-set-1.json b/awscli/botocore/data/waf/2015-08-24/endpoint-rule-set-1.json deleted file mode 100644 index 21e2168f1230..000000000000 --- a/awscli/botocore/data/waf/2015-08-24/endpoint-rule-set-1.json +++ /dev/null @@ -1,416 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://waf.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "waf", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://waf-fips.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "waf", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://waf-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://waf-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://waf.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://waf.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/waf/2015-08-24/paginators-1.json b/awscli/botocore/data/waf/2015-08-24/paginators-1.json deleted file mode 100644 index 9f2eba808e34..000000000000 --- a/awscli/botocore/data/waf/2015-08-24/paginators-1.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "pagination": { - "ListByteMatchSets": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "limit_key": "Limit", - "result_key": "ByteMatchSets" - }, - "ListIPSets": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "limit_key": "Limit", - "result_key": "IPSets" - }, - "ListRules": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "limit_key": "Limit", - "result_key": "Rules" - }, - "ListSizeConstraintSets": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "limit_key": "Limit", - "result_key": "SizeConstraintSets" - }, - "ListSqlInjectionMatchSets": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "limit_key": "Limit", - "result_key": "SqlInjectionMatchSets" - }, - "ListWebACLs": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "limit_key": "Limit", - "result_key": "WebACLs" - }, - "ListXssMatchSets": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "limit_key": "Limit", - "result_key": "XssMatchSets" - }, - "GetRateBasedRuleManagedKeys": { - "input_token": "NextMarker", - "output_token": "NextMarker", - "result_key": "ManagedKeys" - }, - "ListActivatedRulesInRuleGroup": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "ActivatedRules" - }, - "ListGeoMatchSets": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "GeoMatchSets" - }, - "ListLoggingConfigurations": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "LoggingConfigurations" - }, - "ListRateBasedRules": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "Rules" - }, - "ListRegexMatchSets": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "RegexMatchSets" - }, - "ListRegexPatternSets": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "RegexPatternSets" - }, - "ListRuleGroups": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "RuleGroups" - }, - "ListSubscribedRuleGroups": { - "input_token": "NextMarker", - "limit_key": "Limit", - "output_token": "NextMarker", - "result_key": "RuleGroups" - } - } -} diff --git a/awscli/botocore/data/waf/2015-08-24/service-2.json b/awscli/botocore/data/waf/2015-08-24/service-2.json deleted file mode 100644 index 94d956f0a2a6..000000000000 --- a/awscli/botocore/data/waf/2015-08-24/service-2.json +++ /dev/null @@ -1,5361 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2015-08-24", - "endpointPrefix":"waf", - "jsonVersion":"1.1", - "protocol":"json", - "protocols":["json"], - "serviceAbbreviation":"WAF", - "serviceFullName":"AWS WAF", - "serviceId":"WAF", - "signatureVersion":"v4", - "targetPrefix":"AWSWAF_20150824", - "uid":"waf-2015-08-24", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "CreateByteMatchSet":{ - "name":"CreateByteMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateByteMatchSetRequest"}, - "output":{"shape":"CreateByteMatchSetResponse"}, - "errors":[ - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a ByteMatchSet
. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string. For example, you can create a ByteMatchSet
that matches any requests with User-Agent
headers that contain the string BadBot
. You can then configure AWS WAF to reject those requests.
To create and configure a ByteMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateByteMatchSet
request.
Submit a CreateByteMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet
request.
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateGeoMatchSet":{ - "name":"CreateGeoMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateGeoMatchSetRequest"}, - "output":{"shape":"CreateGeoMatchSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet
that contains those countries and then configure AWS WAF to block the requests.
To create and configure a GeoMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateGeoMatchSet
request.
Submit a CreateGeoMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateGeoMatchSet request.
Submit an UpdateGeoMatchSetSet
request to specify the countries that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateIPSet":{ - "name":"CreateIPSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateIPSetRequest"}, - "output":{"shape":"CreateIPSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet
that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateIPSet
request.
Submit a CreateIPSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request.
Submit an UpdateIPSet
request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateRateBasedRule":{ - "name":"CreateRateBasedRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRateBasedRuleRequest"}, - "output":{"shape":"CreateRateBasedRuleResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"}, - {"shape":"WAFBadRequestException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RateBasedRule. The RateBasedRule
contains a RateLimit
, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule
also contains the IPSet
objects, ByteMatchSet
objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit
.
If you add more than one predicate to a RateBasedRule
, a request not only must exceed the RateLimit
, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
Further, you specify a RateLimit
of 1,000.
You then add the RateBasedRule
to a WebACL
and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent
header in the request must contain the value BadBot
. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
A PositionalConstraint
of STARTS_WITH
A TargetString
of login
Further, you specify a RateLimit
of 1,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page without affecting the rest of your site.
To create and configure a RateBasedRule
, perform the following steps:
Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateRule
request.
Submit a CreateRateBasedRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRateBasedRule
request to specify the predicates that you want to include in the rule.
Create and update a WebACL
that contains the RateBasedRule
. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateRegexMatchSet":{ - "name":"CreateRegexMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRegexMatchSetRequest"}, - "output":{"shape":"CreateRegexMatchSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent
header or the query string. For example, you can create a RegexMatchSet
that contains a RegexMatchTuple
that looks for any requests with User-Agent
headers that match a RegexPatternSet
with pattern B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateRegexMatchSet
request.
Submit a CreateRegexMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet
request.
Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet
, that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateRegexPatternSet":{ - "name":"CreateRegexPatternSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRegexPatternSetRequest"}, - "output":{"shape":"CreateRegexPatternSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RegexPatternSet
. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexPatternSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateRegexPatternSet
request.
Submit a CreateRegexPatternSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexPatternSet
request.
Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateRule":{ - "name":"CreateRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRuleRequest"}, - "output":{"shape":"CreateRuleResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"}, - {"shape":"WAFBadRequestException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a Rule
, which contains the IPSet
objects, ByteMatchSet
objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule
, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
You then add the Rule
to a WebACL
and specify that you want to blocks requests that satisfy the Rule
. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent
header in the request must contain the value BadBot
.
To create and configure a Rule
, perform the following steps:
Create and update the predicates that you want to include in the Rule
. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateRule
request.
Submit a CreateRule
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to specify the predicates that you want to include in the Rule
.
Create and update a WebACL
that contains the Rule
. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateRuleGroup":{ - "name":"CreateRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateRuleGroupRequest"}, - "output":{"shape":"CreateRuleGroupResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"}, - {"shape":"WAFBadRequestException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a RuleGroup
. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.
Rule groups are subject to the following limits:
Three rule groups per account. You can request an increase to this limit by contacting customer support.
One rule group per web ACL.
Ten rules per rule group.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateSizeConstraintSet":{ - "name":"CreateSizeConstraintSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSizeConstraintSetRequest"}, - "output":{"shape":"CreateSizeConstraintSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a SizeConstraintSet
. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent
header or the length of the query string. For example, you can create a SizeConstraintSet
that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.
To create and configure a SizeConstraintSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateSizeConstraintSet
request.
Submit a CreateSizeConstraintSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSizeConstraintSet
request.
Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateSqlInjectionMatchSet":{ - "name":"CreateSqlInjectionMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateSqlInjectionMatchSetRequest"}, - "output":{"shape":"CreateSqlInjectionMatchSetResponse"}, - "errors":[ - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure a SqlInjectionMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateSqlInjectionMatchSet
request.
Submit a CreateSqlInjectionMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateSqlInjectionMatchSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "CreateWebACL":{ - "name":"CreateWebACL", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWebACLRequest"}, - "output":{"shape":"CreateWebACLResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"}, - {"shape":"WAFBadRequestException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates a WebACL
, which contains the Rules
that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules
in order based on the value of Priority
for each Rule
.
You also specify a default action, either ALLOW
or BLOCK
. If a web request doesn't match any of the Rules
in a WebACL
, AWS WAF responds to the request with the default action.
To create and configure a WebACL
, perform the following steps:
Create and update the ByteMatchSet
objects and other predicates that you want to include in Rules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more information, see CreateRule and UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateWebACL
request.
Submit a CreateWebACL
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules
that you want to include in the WebACL
, to specify the default action, and to associate the WebACL
with a CloudFront distribution.
For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
" - }, - "CreateWebACLMigrationStack":{ - "name":"CreateWebACLMigrationStack", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateWebACLMigrationStackRequest"}, - "output":{"shape":"CreateWebACLMigrationStackResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFEntityMigrationException"} - ], - "documentation":"Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.
This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide.
" - }, - "CreateXssMatchSet":{ - "name":"CreateXssMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"CreateXssMatchSetRequest"}, - "output":{"shape":"CreateXssMatchSetResponse"}, - "errors":[ - {"shape":"WAFDisallowedNameException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.
To create and configure an XssMatchSet
, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a CreateXssMatchSet
request.
Submit a CreateXssMatchSet
request.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateXssMatchSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "DeleteByteMatchSet":{ - "name":"DeleteByteMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteByteMatchSetRequest"}, - "output":{"shape":"DeleteByteMatchSetResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFNonEmptyEntityException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet
if it's still used in any Rules
or if it still includes any ByteMatchTuple objects (any filters).
If you just want to remove a ByteMatchSet
from a Rule
, use UpdateRule.
To permanently delete a ByteMatchSet
, perform the following steps:
Update the ByteMatchSet
to remove filters, if any. For more information, see UpdateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteByteMatchSet
request.
Submit a DeleteByteMatchSet
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet
if it's still used in any Rules
or if it still includes any countries.
If you just want to remove a GeoMatchSet
from a Rule
, use UpdateRule.
To permanently delete a GeoMatchSet
from AWS WAF, perform the following steps:
Update the GeoMatchSet
to remove any countries. For more information, see UpdateGeoMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteGeoMatchSet
request.
Submit a DeleteGeoMatchSet
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an IPSet. You can't delete an IPSet
if it's still used in any Rules
or if it still includes any IP addresses.
If you just want to remove an IPSet
from a Rule
, use UpdateRule.
To permanently delete an IPSet
from AWS WAF, perform the following steps:
Update the IPSet
to remove IP address ranges, if any. For more information, see UpdateIPSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteIPSet
request.
Submit a DeleteIPSet
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes the LoggingConfiguration from the specified web ACL.
" - }, - "DeletePermissionPolicy":{ - "name":"DeletePermissionPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeletePermissionPolicyRequest"}, - "output":{"shape":"DeletePermissionPolicyResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFNonexistentItemException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
" - }, - "DeleteRateBasedRule":{ - "name":"DeleteRateBasedRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DeleteRateBasedRuleRequest"}, - "output":{"shape":"DeleteRateBasedRuleResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFNonEmptyEntityException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL
objects or if it still includes any predicates, such as ByteMatchSet
objects.
If you just want to remove a rule from a WebACL
, use UpdateWebACL.
To permanently delete a RateBasedRule
from AWS WAF, perform the following steps:
Update the RateBasedRule
to remove predicates, if any. For more information, see UpdateRateBasedRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteRateBasedRule
request.
Submit a DeleteRateBasedRule
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet
if it's still used in any Rules
or if it still includes any RegexMatchTuples
objects (any filters).
If you just want to remove a RegexMatchSet
from a Rule
, use UpdateRule.
To permanently delete a RegexMatchSet
, perform the following steps:
Update the RegexMatchSet
to remove filters, if any. For more information, see UpdateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteRegexMatchSet
request.
Submit a DeleteRegexMatchSet
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet
if it's still used in any RegexMatchSet
or if the RegexPatternSet
is not empty.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a Rule. You can't delete a Rule
if it's still used in any WebACL
objects or if it still includes any predicates, such as ByteMatchSet
objects.
If you just want to remove a Rule
from a WebACL
, use UpdateWebACL.
To permanently delete a Rule
from AWS WAF, perform the following steps:
Update the Rule
to remove predicates, if any. For more information, see UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteRule
request.
Submit a DeleteRule
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a RuleGroup. You can't delete a RuleGroup
if it's still used in any WebACL
objects or if it still includes any rules.
If you just want to remove a RuleGroup
from a WebACL
, use UpdateWebACL.
To permanently delete a RuleGroup
from AWS WAF, perform the following steps:
Update the RuleGroup
to remove rules, if any. For more information, see UpdateRuleGroup.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteRuleGroup
request.
Submit a DeleteRuleGroup
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet
if it's still used in any Rules
or if it still includes any SizeConstraint objects (any filters).
If you just want to remove a SizeConstraintSet
from a Rule
, use UpdateRule.
To permanently delete a SizeConstraintSet
, perform the following steps:
Update the SizeConstraintSet
to remove filters, if any. For more information, see UpdateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteSizeConstraintSet
request.
Submit a DeleteSizeConstraintSet
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet
if it's still used in any Rules
or if it still contains any SqlInjectionMatchTuple objects.
If you just want to remove a SqlInjectionMatchSet
from a Rule
, use UpdateRule.
To permanently delete a SqlInjectionMatchSet
from AWS WAF, perform the following steps:
Update the SqlInjectionMatchSet
to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteSqlInjectionMatchSet
request.
Submit a DeleteSqlInjectionMatchSet
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes a WebACL. You can't delete a WebACL
if it still contains any Rules
.
To delete a WebACL
, perform the following steps:
Update the WebACL
to remove Rules
, if any. For more information, see UpdateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteWebACL
request.
Submit a DeleteWebACL
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Permanently deletes an XssMatchSet. You can't delete an XssMatchSet
if it's still used in any Rules
or if it still contains any XssMatchTuple objects.
If you just want to remove an XssMatchSet
from a Rule
, use UpdateRule.
To permanently delete an XssMatchSet
from AWS WAF, perform the following steps:
Update the XssMatchSet
to remove filters, if any. For more information, see UpdateXssMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteXssMatchSet
request.
Submit a DeleteXssMatchSet
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the ByteMatchSet specified by ByteMatchSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.
Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken
request and then submits a second GetChangeToken
request before submitting a create, update, or delete request, the second GetChangeToken
request returns the same value as the first GetChangeToken
request.
When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING
, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus
to determine the status of your change token.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the status of a ChangeToken
that you got by calling GetChangeToken. ChangeTokenStatus
is one of the following values:
PROVISIONED
: You requested the change token by calling GetChangeToken
, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.
PENDING
: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.
INSYNC
: Propagation is complete.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the GeoMatchSet that is specified by GeoMatchSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the IPSet that is specified by IPSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the LoggingConfiguration for the specified web ACL.
" - }, - "GetPermissionPolicy":{ - "name":"GetPermissionPolicy", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetPermissionPolicyRequest"}, - "output":{"shape":"GetPermissionPolicyResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFNonexistentItemException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the IAM policy attached to the RuleGroup.
" - }, - "GetRateBasedRule":{ - "name":"GetRateBasedRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetRateBasedRuleRequest"}, - "output":{"shape":"GetRateBasedRuleResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFNonexistentItemException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RateBasedRule that is specified by the RuleId
that you included in the GetRateBasedRule
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId
. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RegexMatchSet specified by RegexMatchSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RegexPatternSet specified by RegexPatternSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the Rule that is specified by the RuleId
that you included in the GetRule
request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the RuleGroup that is specified by the RuleGroupId
that you included in the GetRuleGroup
request.
To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
" - }, - "GetSampledRequests":{ - "name":"GetSampledRequests", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GetSampledRequestsRequest"}, - "output":{"shape":"GetSampledRequestsResponse"}, - "errors":[ - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFInternalErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests
returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the SizeConstraintSet specified by SizeConstraintSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the WebACL that is specified by WebACLId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns the XssMatchSet that is specified by XssMatchSetId
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of ActivatedRule objects.
" - }, - "ListByteMatchSets":{ - "name":"ListByteMatchSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListByteMatchSetsRequest"}, - "output":{"shape":"ListByteMatchSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of ByteMatchSetSummary objects.
" - }, - "ListGeoMatchSets":{ - "name":"ListGeoMatchSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListGeoMatchSetsRequest"}, - "output":{"shape":"ListGeoMatchSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of GeoMatchSetSummary objects in the response.
" - }, - "ListIPSets":{ - "name":"ListIPSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListIPSetsRequest"}, - "output":{"shape":"ListIPSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of IPSetSummary objects in the response.
" - }, - "ListLoggingConfigurations":{ - "name":"ListLoggingConfigurations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListLoggingConfigurationsRequest"}, - "output":{"shape":"ListLoggingConfigurationsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFInvalidParameterException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of LoggingConfiguration objects.
" - }, - "ListRateBasedRules":{ - "name":"ListRateBasedRules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRateBasedRulesRequest"}, - "output":{"shape":"ListRateBasedRulesResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
" - }, - "ListRegexMatchSets":{ - "name":"ListRegexMatchSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRegexMatchSetsRequest"}, - "output":{"shape":"ListRegexMatchSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexMatchSetSummary objects.
" - }, - "ListRegexPatternSets":{ - "name":"ListRegexPatternSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRegexPatternSetsRequest"}, - "output":{"shape":"ListRegexPatternSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RegexPatternSetSummary objects.
" - }, - "ListRuleGroups":{ - "name":"ListRuleGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRuleGroupsRequest"}, - "output":{"shape":"ListRuleGroupsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects.
" - }, - "ListRules":{ - "name":"ListRules", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListRulesRequest"}, - "output":{"shape":"ListRulesResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleSummary objects.
" - }, - "ListSizeConstraintSets":{ - "name":"ListSizeConstraintSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSizeConstraintSetsRequest"}, - "output":{"shape":"ListSizeConstraintSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SizeConstraintSetSummary objects.
" - }, - "ListSqlInjectionMatchSets":{ - "name":"ListSqlInjectionMatchSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSqlInjectionMatchSetsRequest"}, - "output":{"shape":"ListSqlInjectionMatchSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of SqlInjectionMatchSet objects.
" - }, - "ListSubscribedRuleGroups":{ - "name":"ListSubscribedRuleGroups", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListSubscribedRuleGroupsRequest"}, - "output":{"shape":"ListSubscribedRuleGroupsResponse"}, - "errors":[ - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFInternalErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of RuleGroup objects that you are subscribed to.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFBadRequestException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" - }, - "ListWebACLs":{ - "name":"ListWebACLs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListWebACLsRequest"}, - "output":{"shape":"ListWebACLsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of WebACLSummary objects in the response.
" - }, - "ListXssMatchSets":{ - "name":"ListXssMatchSets", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListXssMatchSetsRequest"}, - "output":{"shape":"ListXssMatchSetsResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of XssMatchSet objects.
" - }, - "PutLoggingConfiguration":{ - "name":"PutLoggingConfiguration", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"PutLoggingConfigurationRequest"}, - "output":{"shape":"PutLoggingConfigurationResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFServiceLinkedRoleErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates a LoggingConfiguration with a specified web ACL.
You can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Do not create the data firehose using a Kinesis stream
as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration
request.
When you successfully enable logging using a PutLoggingConfiguration
request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
The PutPermissionPolicy
is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
, waf-regional:UpdateWebACL
, waf:GetRuleGroup
and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
The user making the request must be the owner of the RuleGroup.
Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see IAM Policies.
An example of a valid policy parameter is shown in the Examples section below.
" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFBadRequestException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFBadRequestException"}, - {"shape":"WAFTagOperationException"}, - {"shape":"WAFTagOperationInternalErrorException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent
header.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString
in the ByteMatchTuple data type.
Where to look, such as at the beginning or the end of a query string.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a ByteMatchSetUpdate
object that matches web requests in which User-Agent
headers contain the string BadBot
. You can then configure AWS WAF to block those requests.
To create and configure a ByteMatchSet
, perform the following steps:
Create a ByteMatchSet.
For more information, see CreateByteMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateByteMatchSet
request.
Submit an UpdateByteMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateGeoMatchSet":{ - "name":"UpdateGeoMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateGeoMatchSetRequest"}, - "output":{"shape":"UpdateGeoMatchSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet
. For each GeoMatchConstraint
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint
object, you delete the existing object and add a new one.
The Type
. The only valid value for Type
is Country
.
The Value
, which is a two character code for the country to add to the GeoMatchConstraint
object. Valid codes are listed in GeoMatchConstraint$Value.
To create and configure an GeoMatchSet
, perform the following steps:
Submit a CreateGeoMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateGeoMatchSet request.
Submit an UpdateGeoMatchSet
request to specify the country that you want AWS WAF to watch for.
When you update an GeoMatchSet
, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateIPSet":{ - "name":"UpdateIPSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateIPSetRequest"}, - "output":{"shape":"UpdateIPSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes IPSetDescriptor objects in an IPSet
. For each IPSetDescriptor
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor
object, you delete the existing object and add a new one.
The IP address version, IPv4
or IPv6
.
The IP address in CIDR notation, for example, 192.0.2.0/24
(for the range of IP addresses from 192.0.2.0
to 192.0.2.255
) or 192.0.2.44/32
(for the individual IP address 192.0.2.44
).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
IPv6 addresses can be represented using any of the following formats:
1111:0000:0000:0000:0000:0000:0000:0111/128
1111:0:0:0:0:0:0:0111/128
1111::0111/128
1111::111/128
You use an IPSet
to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet
that specifies those IP addresses, and then configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following steps:
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request.
Submit an UpdateIPSet
request to specify the IP addresses that you want AWS WAF to watch for.
When you update an IPSet
, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.
You can insert a maximum of 1000 addresses in a single request.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateRateBasedRule":{ - "name":"UpdateRateBasedRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRateBasedRuleRequest"}, - "output":{"shape":"UpdateRateBasedRuleResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes Predicate objects in a rule and updates the RateLimit
in the rule.
Each Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit
specifies the number of requests every five minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule
, a request must match all the predicates and exceed the RateLimit
to be counted or blocked. For example, suppose you add the following to a RateBasedRule
:
An IPSet
that matches the IP address 192.0.2.44/32
A ByteMatchSet
that matches BadBot
in the User-Agent
header
Further, you specify a RateLimit
of 1,000.
You then add the RateBasedRule
to a WebACL
and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent
header in the request must contain the value BadBot
. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.
As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule
:
A ByteMatchSet
with FieldToMatch
of URI
A PositionalConstraint
of STARTS_WITH
A TargetString
of login
Further, you specify a RateLimit
of 1,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests to your login page without affecting the rest of your site.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a RegexPatternSet
that matches any requests with User-Agent
headers that contain the string B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
To create and configure a RegexMatchSet
, perform the following steps:
Create a RegexMatchSet.
For more information, see CreateRegexMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexMatchSet
request.
Submit an UpdateRegexMatchSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet
that contain the regular expression patters you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateRegexPatternSet":{ - "name":"UpdateRegexPatternSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRegexPatternSetRequest"}, - "output":{"shape":"UpdateRegexPatternSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidRegexPatternException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes RegexPatternString
objects in a RegexPatternSet. For each RegexPatternString
object, you specify the following values:
Whether to insert or delete the RegexPatternString
.
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
For example, you can create a RegexPatternString
such as B[a@]dB[o0]t
. AWS WAF will match this RegexPatternString
to:
BadBot
BadB0t
B@dBot
B@dB0t
To create and configure a RegexPatternSet
, perform the following steps:
Create a RegexPatternSet.
For more information, see CreateRegexPatternSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateRegexPatternSet
request.
Submit an UpdateRegexPatternSet
request to specify the regular expression pattern that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateRule":{ - "name":"UpdateRule", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRuleRequest"}, - "output":{"shape":"UpdateRuleResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes Predicate objects in a Rule
. Each Predicate
object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule
, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule
:
A ByteMatchSet
that matches the value BadBot
in the User-Agent
header
An IPSet
that matches the IP address 192.0.2.44
You then add the Rule
to a WebACL
and specify that you want to block requests that satisfy the Rule
. For a request to be blocked, the User-Agent
header in the request must contain the value BadBot
and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule
, perform the following steps:
Create and update the predicates that you want to include in the Rule
.
Create the Rule
. See CreateRule.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRule request.
Submit an UpdateRule
request to add predicates to the Rule
.
Create and update a WebACL
that contains the Rule
. See CreateWebACL.
If you want to replace one ByteMatchSet
or IPSet
with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateRuleGroup":{ - "name":"UpdateRuleGroup", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateRuleGroupRequest"}, - "output":{"shape":"UpdateRuleGroupResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFInvalidParameterException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ActivatedRule objects in a RuleGroup
.
You can only insert REGULAR
rules into a rule group.
You can have a maximum of ten rules per rule group.
To create and configure a RuleGroup
, perform the following steps:
Create and update the Rules
that you want to include in the RuleGroup
. See CreateRule.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateRuleGroup request.
Submit an UpdateRuleGroup
request to add Rules
to the RuleGroup
.
Create and update a WebACL
that contains the RuleGroup
. See CreateWebACL.
If you want to replace one Rule
with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateSizeConstraintSet":{ - "name":"UpdateSizeConstraintSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSizeConstraintSetRequest"}, - "output":{"shape":"UpdateSizeConstraintSetResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint
object, you specify the following values:
Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate
object, you delete the existing object and add a new one.
The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent
header.
Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192
bytes of your request to AWS WAF.
You can only specify a single type of TextTransformation.
A ComparisonOperator
used for evaluating the selected part of the request against the specified Size
, such as equals, greater than, less than, and so on.
The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.
For example, you can add a SizeConstraintSetUpdate
object that matches web requests in which the length of the User-Agent
header is greater than 100 bytes. You can then configure AWS WAF to block those requests.
To create and configure a SizeConstraintSet
, perform the following steps:
Create a SizeConstraintSet.
For more information, see CreateSizeConstraintSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateSizeConstraintSet
request.
Submit an UpdateSizeConstraintSet
request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateSqlInjectionMatchSet":{ - "name":"UpdateSqlInjectionMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateSqlInjectionMatchSetRequest"}, - "output":{"shape":"UpdateSqlInjectionMatchSetResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple
object, you specify the following values:
Action
: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple
, you delete the existing object and add a new one.
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation
: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use SqlInjectionMatchSet
objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet
with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet
, perform the following steps:
Submit a CreateSqlInjectionMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request.
Submit an UpdateSqlInjectionMatchSet
request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateWebACL":{ - "name":"UpdateWebACL", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateWebACLRequest"}, - "output":{"shape":"UpdateWebACLResponse"}, - "errors":[ - {"shape":"WAFStaleDataException"}, - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFReferencedItemException"}, - {"shape":"WAFLimitsExceededException"}, - {"shape":"WAFSubscriptionNotFoundException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ActivatedRule objects in a WebACL
. Each Rule
identifies web requests that you want to allow, block, or count. When you update a WebACL
, you specify the following values:
A default action for the WebACL
, either ALLOW
or BLOCK
. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules
in a WebACL
.
The Rules
that you want to add or delete. If you want to replace one Rule
with another, you delete the existing Rule
and add the new one.
For each Rule
, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule
.
The order in which you want AWS WAF to evaluate the Rules
in a WebACL
. If you add more than one Rule
to a WebACL
, AWS WAF evaluates each request against the Rules
in order based on the value of Priority
. (The Rule
that has the lowest value for Priority
is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets
and IPSets
) in a Rule
, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules
in the WebACL
, if any.
To create and configure a WebACL
, perform the following steps:
Create and update the predicates that you want to include in Rules
. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules
that you want to include in the WebACL
. For more information, see CreateRule and UpdateRule.
Create a WebACL
. See CreateWebACL.
Use GetChangeToken
to get the change token that you provide in the ChangeToken
parameter of an UpdateWebACL request.
Submit an UpdateWebACL
request to specify the Rules
that you want to include in the WebACL
, to specify the default action, and to associate the WebACL
with a CloudFront distribution.
The ActivatedRule
can be a rule group. If you specify a rule group as your ActivatedRule
, you can exclude specific rules from that rule group.
If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL
request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules .
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - }, - "UpdateXssMatchSet":{ - "name":"UpdateXssMatchSet", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateXssMatchSetRequest"}, - "output":{"shape":"UpdateXssMatchSetResponse"}, - "errors":[ - {"shape":"WAFInternalErrorException"}, - {"shape":"WAFInvalidAccountException"}, - {"shape":"WAFInvalidOperationException"}, - {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFNonexistentContainerException"}, - {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFStaleDataException"}, - {"shape":"WAFLimitsExceededException"} - ], - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple
object, you specify the following values:
Action
: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple
, you delete the existing object and add a new one.
FieldToMatch
: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation
: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use XssMatchSet
objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet
with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet
, perform the following steps:
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of an UpdateIPSet request.
Submit an UpdateXssMatchSet
request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" - } - }, - "shapes":{ - "Action":{"type":"string"}, - "ActivatedRule":{ - "type":"structure", - "required":[ - "Priority", - "RuleId" - ], - "members":{ - "Priority":{ - "shape":"RulePriority", - "documentation":"Specifies the order in which the Rules
in a WebACL
are evaluated. Rules with a lower value for Priority
are evaluated before Rules
with a higher value. The value must be a unique integer. If you add multiple Rules
to a WebACL
, the values don't need to be consecutive.
The RuleId
for a Rule
. You use RuleId
to get more information about a Rule
(see GetRule), update a Rule
(see UpdateRule), insert a Rule
into a WebACL
or delete a one from a WebACL
(see UpdateWebACL), or delete a Rule
from AWS WAF (see DeleteRule).
RuleId
is returned by CreateRule and by ListRules.
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule
. Valid values for Action
include the following:
ALLOW
: CloudFront responds with the requested object.
BLOCK
: CloudFront responds with an HTTP 403 (Forbidden) status code.
COUNT
: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction
applies only when updating or adding a RuleGroup
to a WebACL
. In this case, you do not use ActivatedRule|Action
. For all other update requests, ActivatedRule|Action
is used instead of ActivatedRule|OverrideAction
.
Use the OverrideAction
to test your RuleGroup
.
Any rule in a RuleGroup
can potentially block a request. If you set the OverrideAction
to None
, the RuleGroup
will block a request if any individual rule in the RuleGroup
matches the request and is configured to block that request. However if you first want to test the RuleGroup
, set the OverrideAction
to Count
. The RuleGroup
will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.
ActivatedRule|OverrideAction
applies only when updating or adding a RuleGroup
to a WebACL
. In this case you do not use ActivatedRule|Action
. For all other update requests, ActivatedRule|Action
is used instead of ActivatedRule|OverrideAction
.
The rule type, either REGULAR
, as defined by Rule, RATE_BASED
, as defined by RateBasedRule, or GROUP
, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.
An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule
refers to a RuleGroup
.
Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying ExcludedRules
does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT
. Therefore, requests that match an ExcludedRule
are counted but not blocked. The RuleGroup
owner will receive COUNT metrics for each ExcludedRule
.
If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
Submit an UpdateWebACL request that has two actions:
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action
should be DELETE
and Updates:ActivatedRule:RuleId
should be the rule group that contains the rules that you want to exclude.
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action
should be INSERT
, Updates:ActivatedRule:RuleId
should be the rule group that you just removed, and ExcludedRules
should contain the rules that you want to exclude.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The ActivatedRule
object in an UpdateWebACL request specifies a Rule
that you want to insert or delete, the priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a web request matches the Rule
(ALLOW
, BLOCK
, or COUNT
).
To specify whether to insert or delete a Rule
, use the Action
parameter in the WebACLUpdate data type.
The ByteMatchSetId
for a ByteMatchSet
. You use ByteMatchSetId
to get information about a ByteMatchSet
(see GetByteMatchSet), update a ByteMatchSet
(see UpdateByteMatchSet), insert a ByteMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a ByteMatchSet
from AWS WAF (see DeleteByteMatchSet).
ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
A friendly name or description of the ByteMatchSet. You can't change Name
after you create a ByteMatchSet
.
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In a GetByteMatchSet request, ByteMatchSet
is a complex type that contains the ByteMatchSetId
and Name
of a ByteMatchSet
, and the values that you specified when you updated the ByteMatchSet
.
A complex type that contains ByteMatchTuple
objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet
contains more than one ByteMatchTuple
object, a request needs to match the settings in only one ByteMatchTuple
to be considered a match.
The ByteMatchSetId
for a ByteMatchSet
. You use ByteMatchSetId
to get information about a ByteMatchSet
, update a ByteMatchSet
, remove a ByteMatchSet
from a Rule
, and delete a ByteMatchSet
from AWS WAF.
ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
A friendly name or description of the ByteMatchSet. You can't change Name
after you create a ByteMatchSet
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returned by ListByteMatchSets. Each ByteMatchSetSummary
object includes the Name
and ByteMatchSetId
for one ByteMatchSet.
Specifies whether to insert or delete a ByteMatchTuple.
" - }, - "ByteMatchTuple":{ - "shape":"ByteMatchTuple", - "documentation":"Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE
for the value of Action
, the ByteMatchTuple
values must exactly match the values in the ByteMatchTuple
that you want to delete from the ByteMatchSet
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In an UpdateByteMatchSet request, ByteMatchSetUpdate
specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple
.
The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.
" - }, - "TargetString":{ - "shape":"ByteMatchTargetString", - "documentation":"The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch
. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch
:
HEADER
: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent
or Referer
header.
METHOD
: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE
, GET
, HEAD
, OPTIONS
, PATCH
, POST
, and PUT
.
QUERY_STRING
: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ?
character.
URI
: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg
.
BODY
: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192
bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG
: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG
is 30 characters.
ALL_QUERY_ARGS
: Similar to SINGLE_QUERY_ARG
, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString
.
If TargetString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type
is HEADER
and the value of Data
is User-Agent
. If you want to search the User-Agent
header for the value BadBot
, you base64-encode BadBot
using MIME base64-encoding and include the resulting value, QmFkQm90
, in the value of TargetString
.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" - }, - "TextTransformation":{ - "shape":"TextTransformation", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \\ \" ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\\f, formfeed, decimal 12
\\t, tab, decimal 9
\\n, newline, decimal 10
\\r, carriage return, decimal 13
\\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot;
with \"
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE
if you don't want to perform any text transformations.
Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of TargetString
, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of TargetString
, and TargetString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString
must be a word, which means one of the following:
TargetString
exactly matches the value of the specified part of the web request, such as the value of a header.
TargetString
is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;
.
TargetString
is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot
.
TargetString
is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of TargetString
.
STARTS_WITH
The value of TargetString
must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of TargetString
must appear at the end of the specified part of the web request.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
" - }, - "ByteMatchTuples":{ - "type":"list", - "member":{"shape":"ByteMatchTuple"} - }, - "ChangeAction":{ - "type":"string", - "enum":[ - "INSERT", - "DELETE" - ] - }, - "ChangeToken":{ - "type":"string", - "max":128, - "min":1, - "pattern":".*\\S.*" - }, - "ChangeTokenStatus":{ - "type":"string", - "enum":[ - "PROVISIONED", - "PENDING", - "INSYNC" - ] - }, - "ComparisonOperator":{ - "type":"string", - "enum":[ - "EQ", - "NE", - "LE", - "LT", - "GE", - "GT" - ] - }, - "Country":{"type":"string"}, - "CreateByteMatchSetRequest":{ - "type":"structure", - "required":[ - "Name", - "ChangeToken" - ], - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"A friendly name or description of the ByteMatchSet. You can't change Name
after you create a ByteMatchSet
.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "CreateByteMatchSetResponse":{ - "type":"structure", - "members":{ - "ByteMatchSet":{ - "shape":"ByteMatchSet", - "documentation":"A ByteMatchSet that contains no ByteMatchTuple
objects.
The ChangeToken
that you used to submit the CreateByteMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the GeoMatchSet. You can't change Name
after you create the GeoMatchSet
.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "CreateGeoMatchSetResponse":{ - "type":"structure", - "members":{ - "GeoMatchSet":{ - "shape":"GeoMatchSet", - "documentation":"The GeoMatchSet returned in the CreateGeoMatchSet
response. The GeoMatchSet
contains no GeoMatchConstraints
.
The ChangeToken
that you used to submit the CreateGeoMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the IPSet. You can't change Name
after you create the IPSet
.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "CreateIPSetResponse":{ - "type":"structure", - "members":{ - "IPSet":{ - "shape":"IPSet", - "documentation":"The IPSet returned in the CreateIPSet
response.
The ChangeToken
that you used to submit the CreateIPSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule
after you create it.
A friendly name or description for the metrics for this RateBasedRule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RateBasedRule
.
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey
is IP
. IP
indicates that requests that arrive from the same IP address are subject to the RateLimit
that is specified in the RateBasedRule
.
The maximum number of requests, which have an identical value in the field that is specified by RateKey
, allowed in a five-minute period. If the number of requests exceeds the RateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
The ChangeToken
that you used to submit the CreateRateBasedRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RateBasedRule that is returned in the CreateRateBasedRule
response.
The ChangeToken
that you used to submit the CreateRateBasedRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a RegexMatchSet
.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "CreateRegexMatchSetResponse":{ - "type":"structure", - "members":{ - "RegexMatchSet":{ - "shape":"RegexMatchSet", - "documentation":"A RegexMatchSet that contains no RegexMatchTuple
objects.
The ChangeToken
that you used to submit the CreateRegexMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the RegexPatternSet. You can't change Name
after you create a RegexPatternSet
.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "CreateRegexPatternSetResponse":{ - "type":"structure", - "members":{ - "RegexPatternSet":{ - "shape":"RegexPatternSet", - "documentation":"A RegexPatternSet that contains no objects.
" - }, - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the CreateRegexPatternSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the RuleGroup. You can't change Name
after you create a RuleGroup
.
A friendly name or description for the metrics for this RuleGroup
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup
.
The value returned by the most recent call to GetChangeToken.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"" - } - } - }, - "CreateRuleGroupResponse":{ - "type":"structure", - "members":{ - "RuleGroup":{ - "shape":"RuleGroup", - "documentation":"An empty RuleGroup.
" - }, - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the CreateRuleGroup
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the Rule. You can't change the name of a Rule
after you create it.
A friendly name or description for the metrics for this Rule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the Rule
.
The value returned by the most recent call to GetChangeToken.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"" - } - } - }, - "CreateRuleResponse":{ - "type":"structure", - "members":{ - "Rule":{ - "shape":"Rule", - "documentation":"The Rule returned in the CreateRule
response.
The ChangeToken
that you used to submit the CreateRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description of the SizeConstraintSet. You can't change Name
after you create a SizeConstraintSet
.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "CreateSizeConstraintSetResponse":{ - "type":"structure", - "members":{ - "SizeConstraintSet":{ - "shape":"SizeConstraintSet", - "documentation":"A SizeConstraintSet that contains no SizeConstraint
objects.
The ChangeToken
that you used to submit the CreateSizeConstraintSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name
after you create the SqlInjectionMatchSet
.
The value returned by the most recent call to GetChangeToken.
" - } - }, - "documentation":"A request to create a SqlInjectionMatchSet.
" - }, - "CreateSqlInjectionMatchSetResponse":{ - "type":"structure", - "members":{ - "SqlInjectionMatchSet":{ - "shape":"SqlInjectionMatchSet", - "documentation":"" - }, - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the CreateSqlInjectionMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The response to a CreateSqlInjectionMatchSet
request.
The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.
" - }, - "S3BucketName":{ - "shape":"S3BucketName", - "documentation":"The name of the Amazon S3 bucket to store the CloudFormation template in. The S3 bucket must be configured as follows for the migration:
The bucket name must start with aws-waf-migration-
. For example, aws-waf-migration-my-web-acl
.
The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2.
The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section.
Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception.
" - } - } - }, - "CreateWebACLMigrationStackResponse":{ - "type":"structure", - "required":["S3ObjectUrl"], - "members":{ - "S3ObjectUrl":{ - "shape":"S3ObjectUrl", - "documentation":"The URL of the template created in Amazon S3.
" - } - } - }, - "CreateWebACLRequest":{ - "type":"structure", - "required":[ - "Name", - "MetricName", - "DefaultAction", - "ChangeToken" - ], - "members":{ - "Name":{ - "shape":"ResourceName", - "documentation":"A friendly name or description of the WebACL. You can't change Name
after you create the WebACL
.
A friendly name or description for the metrics for this WebACL
.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName
after you create the WebACL
.
The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule
objects that are associated with the WebACL
.
The value returned by the most recent call to GetChangeToken.
" - }, - "Tags":{ - "shape":"TagList", - "documentation":"" - } - } - }, - "CreateWebACLResponse":{ - "type":"structure", - "members":{ - "WebACL":{ - "shape":"WebACL", - "documentation":"The WebACL returned in the CreateWebACL
response.
The ChangeToken
that you used to submit the CreateWebACL
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
A friendly name or description for the XssMatchSet that you're creating. You can't change Name
after you create the XssMatchSet
.
The value returned by the most recent call to GetChangeToken.
" - } - }, - "documentation":"A request to create an XssMatchSet.
" - }, - "CreateXssMatchSetResponse":{ - "type":"structure", - "members":{ - "XssMatchSet":{ - "shape":"XssMatchSet", - "documentation":"An XssMatchSet.
" - }, - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the CreateXssMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The response to a CreateXssMatchSet
request.
The ByteMatchSetId
of the ByteMatchSet that you want to delete. ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteByteMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteByteMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The GeoMatchSetID
of the GeoMatchSet that you want to delete. GeoMatchSetId
is returned by CreateGeoMatchSet and by ListGeoMatchSets.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteGeoMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteGeoMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The IPSetId
of the IPSet that you want to delete. IPSetId
is returned by CreateIPSet and by ListIPSets.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteIPSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteIPSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
" - } - } - }, - "DeleteLoggingConfigurationResponse":{ - "type":"structure", - "members":{} - }, - "DeletePermissionPolicyRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.
The user making the request must be the owner of the RuleGroup.
" - } - } - }, - "DeletePermissionPolicyResponse":{ - "type":"structure", - "members":{} - }, - "DeleteRateBasedRuleRequest":{ - "type":"structure", - "required":[ - "RuleId", - "ChangeToken" - ], - "members":{ - "RuleId":{ - "shape":"ResourceId", - "documentation":"The RuleId
of the RateBasedRule that you want to delete. RuleId
is returned by CreateRateBasedRule and by ListRateBasedRules.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteRateBasedRuleResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteRateBasedRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RegexMatchSetId
of the RegexMatchSet that you want to delete. RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteRegexMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteRegexMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RegexPatternSetId
of the RegexPatternSet that you want to delete. RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteRegexPatternSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteRegexPatternSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RuleGroupId
of the RuleGroup that you want to delete. RuleGroupId
is returned by CreateRuleGroup and by ListRuleGroups.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteRuleGroupResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteRuleGroup
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RuleId
of the Rule that you want to delete. RuleId
is returned by CreateRule and by ListRules.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteRuleResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The SizeConstraintSetId
of the SizeConstraintSet that you want to delete. SizeConstraintSetId
is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteSizeConstraintSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteSizeConstraintSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The SqlInjectionMatchSetId
of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The value returned by the most recent call to GetChangeToken.
" - } - }, - "documentation":"A request to delete a SqlInjectionMatchSet from AWS WAF.
" - }, - "DeleteSqlInjectionMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteSqlInjectionMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The response to a request to delete a SqlInjectionMatchSet from AWS WAF.
" - }, - "DeleteWebACLRequest":{ - "type":"structure", - "required":[ - "WebACLId", - "ChangeToken" - ], - "members":{ - "WebACLId":{ - "shape":"ResourceId", - "documentation":"The WebACLId
of the WebACL that you want to delete. WebACLId
is returned by CreateWebACL and by ListWebACLs.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "DeleteWebACLResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteWebACL
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The XssMatchSetId
of the XssMatchSet that you want to delete. XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The value returned by the most recent call to GetChangeToken.
" - } - }, - "documentation":"A request to delete an XssMatchSet from AWS WAF.
" - }, - "DeleteXssMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the DeleteXssMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The response to a request to delete an XssMatchSet from AWS WAF.
" - }, - "ErrorReason":{"type":"string"}, - "ExcludedRule":{ - "type":"structure", - "required":["RuleId"], - "members":{ - "RuleId":{ - "shape":"ResourceId", - "documentation":"The unique identifier for the rule to exclude from the rule group.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The rule to exclude from a rule group. This is applicable only when the ActivatedRule
refers to a RuleGroup
. The rule must belong to the RuleGroup
that is specified by the ActivatedRule
.
The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:
HEADER
: A specified request header, for example, the value of the User-Agent
or Referer
header. If you choose HEADER
for the type, specify the name of the header in Data
.
METHOD
: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE
, GET
, HEAD
, OPTIONS
, PATCH
, POST
, and PUT
.
QUERY_STRING
: A query string, which is the part of a URL that appears after a ?
character, if any.
URI
: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg
.
BODY
: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192
bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG
: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG
is 30 characters.
ALL_QUERY_ARGS
: Similar to SINGLE_QUERY_ARG
, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString
.
When the value of Type
is HEADER
, enter the name of the header that you want AWS WAF to search, for example, User-Agent
or Referer
. The name of the header is not case sensitive.
When the value of Type
is SINGLE_QUERY_ARG
, enter the name of the parameter that you want AWS WAF to search, for example, UserName
or SalesRegion
. The parameter name is not case sensitive.
If the value of Type
is any other value, omit Data
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies where in a web request to look for TargetString
.
The type of geographical area you want AWS WAF to search for. Currently Country
is the only valid value.
The country that you want AWS WAF to search for.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The country from which web requests originate that you want AWS WAF to search for.
" - }, - "GeoMatchConstraintType":{ - "type":"string", - "enum":["Country"] - }, - "GeoMatchConstraintValue":{ - "type":"string", - "enum":[ - "AF", - "AX", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "CI", - "HR", - "CU", - "CW", - "CY", - "CZ", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RE", - "RO", - "RU", - "RW", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW" - ] - }, - "GeoMatchConstraints":{ - "type":"list", - "member":{"shape":"GeoMatchConstraint"} - }, - "GeoMatchSet":{ - "type":"structure", - "required":[ - "GeoMatchSetId", - "GeoMatchConstraints" - ], - "members":{ - "GeoMatchSetId":{ - "shape":"ResourceId", - "documentation":"The GeoMatchSetId
for an GeoMatchSet
. You use GeoMatchSetId
to get information about a GeoMatchSet
(see GeoMatchSet), update a GeoMatchSet
(see UpdateGeoMatchSet), insert a GeoMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a GeoMatchSet
from AWS WAF (see DeleteGeoMatchSet).
GeoMatchSetId
is returned by CreateGeoMatchSet and by ListGeoMatchSets.
A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet
after you create it.
An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains one or more countries that AWS WAF will search for.
" - }, - "GeoMatchSetSummaries":{ - "type":"list", - "member":{"shape":"GeoMatchSetSummary"} - }, - "GeoMatchSetSummary":{ - "type":"structure", - "required":[ - "GeoMatchSetId", - "Name" - ], - "members":{ - "GeoMatchSetId":{ - "shape":"ResourceId", - "documentation":"The GeoMatchSetId
for an GeoMatchSet. You can use GeoMatchSetId
in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.
A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet
after you create it.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the name of the GeoMatchSet
.
Specifies whether to insert or delete a country with UpdateGeoMatchSet.
" - }, - "GeoMatchConstraint":{ - "shape":"GeoMatchConstraint", - "documentation":"The country from which web requests originate that you want AWS WAF to search for.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.
" - }, - "GeoMatchSetUpdates":{ - "type":"list", - "member":{"shape":"GeoMatchSetUpdate"}, - "min":1 - }, - "GetByteMatchSetRequest":{ - "type":"structure", - "required":["ByteMatchSetId"], - "members":{ - "ByteMatchSetId":{ - "shape":"ResourceId", - "documentation":"The ByteMatchSetId
of the ByteMatchSet that you want to get. ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
Information about the ByteMatchSet that you specified in the GetByteMatchSet
request. For more information, see the following topics:
ByteMatchSet: Contains ByteMatchSetId
, ByteMatchTuples
, and Name
ByteMatchTuples
: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple
object contains FieldToMatch, PositionalConstraint
, TargetString
, and TextTransformation
FieldToMatch: Contains Data
and Type
The ChangeToken
that you used in the request. Use this value in a GetChangeTokenStatus
request to get the current status of the request.
The change token for which you want to get the status. This change token was previously returned in the GetChangeToken
response.
The status of the change token.
" - } - } - }, - "GetGeoMatchSetRequest":{ - "type":"structure", - "required":["GeoMatchSetId"], - "members":{ - "GeoMatchSetId":{ - "shape":"ResourceId", - "documentation":"The GeoMatchSetId
of the GeoMatchSet that you want to get. GeoMatchSetId
is returned by CreateGeoMatchSet and by ListGeoMatchSets.
Information about the GeoMatchSet that you specified in the GetGeoMatchSet
request. This includes the Type
, which for a GeoMatchContraint
is always Country
, as well as the Value
, which is the identifier for a specific country.
The IPSetId
of the IPSet that you want to get. IPSetId
is returned by CreateIPSet and by ListIPSets.
Information about the IPSet that you specified in the GetIPSet
request. For more information, see the following topics:
IPSet: Contains IPSetDescriptors
, IPSetId
, and Name
IPSetDescriptors
: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor
object contains Type
and Value
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
" - } - } - }, - "GetLoggingConfigurationResponse":{ - "type":"structure", - "members":{ - "LoggingConfiguration":{ - "shape":"LoggingConfiguration", - "documentation":"The LoggingConfiguration for the specified web ACL.
" - } - } - }, - "GetPermissionPolicyRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.
" - } - } - }, - "GetPermissionPolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"PolicyString", - "documentation":"The IAM policy attached to the specified RuleGroup.
" - } - } - }, - "GetRateBasedRuleManagedKeysRequest":{ - "type":"structure", - "required":["RuleId"], - "members":{ - "RuleId":{ - "shape":"ResourceId", - "documentation":"The RuleId
of the RateBasedRule for which you want to get a list of ManagedKeys
. RuleId
is returned by CreateRateBasedRule and by ListRateBasedRules.
A null value and not currently used. Do not include this in your request.
" - } - } - }, - "GetRateBasedRuleManagedKeysResponse":{ - "type":"structure", - "members":{ - "ManagedKeys":{ - "shape":"ManagedKeys", - "documentation":"An array of IP addresses that currently are blocked by the specified RateBasedRule.
" - }, - "NextMarker":{ - "shape":"NextMarker", - "documentation":"A null value and not currently used.
" - } - } - }, - "GetRateBasedRuleRequest":{ - "type":"structure", - "required":["RuleId"], - "members":{ - "RuleId":{ - "shape":"ResourceId", - "documentation":"The RuleId
of the RateBasedRule that you want to get. RuleId
is returned by CreateRateBasedRule and by ListRateBasedRules.
Information about the RateBasedRule that you specified in the GetRateBasedRule
request.
The RegexMatchSetId
of the RegexMatchSet that you want to get. RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
Information about the RegexMatchSet that you specified in the GetRegexMatchSet
request. For more information, see RegexMatchTuple.
The RegexPatternSetId
of the RegexPatternSet that you want to get. RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
Information about the RegexPatternSet that you specified in the GetRegexPatternSet
request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.
The RuleGroupId
of the RuleGroup that you want to get. RuleGroupId
is returned by CreateRuleGroup and by ListRuleGroups.
Information about the RuleGroup that you specified in the GetRuleGroup
request.
The RuleId
of the Rule that you want to get. RuleId
is returned by CreateRule and by ListRules.
Information about the Rule that you specified in the GetRule
request. For more information, see the following topics:
Rule: Contains MetricName
, Name
, an array of Predicate
objects, and RuleId
Predicate: Each Predicate
object contains DataId
, Negated
, and Type
The WebACLId
of the WebACL
for which you want GetSampledRequests
to return a sample of requests.
RuleId
is one of three values:
The RuleId
of the Rule
or the RuleGroupId
of the RuleGroup
for which you want GetSampledRequests
to return a sample of requests.
Default_Action
, which causes GetSampledRequests
to return a sample of the requests that didn't match any of the rules in the specified WebACL
.
The start date and time and the end date and time of the range for which you want GetSampledRequests
to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z
. For example, \"2016-09-27T14:50Z\"
. You can specify any time range in the previous three hours.
The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems
, GetSampledRequests
returns information about all of them.
A complex type that contains detailed information about each of the requests in the sample.
" - }, - "PopulationSize":{ - "shape":"PopulationSize", - "documentation":"The total number of requests from which GetSampledRequests
got a sample of MaxItems
requests. If PopulationSize
is less than MaxItems
, the sample includes every request that your AWS resource received during the specified time range.
Usually, TimeWindow
is the time range that you specified in the GetSampledRequests
request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests
returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
The SizeConstraintSetId
of the SizeConstraintSet that you want to get. SizeConstraintSetId
is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet
request. For more information, see the following topics:
SizeConstraintSet: Contains SizeConstraintSetId
, SizeConstraints
, and Name
SizeConstraints
: Contains an array of SizeConstraint objects. Each SizeConstraint
object contains FieldToMatch, TextTransformation
, ComparisonOperator
, and Size
FieldToMatch: Contains Data
and Type
The SqlInjectionMatchSetId
of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
A request to get a SqlInjectionMatchSet.
" - }, - "GetSqlInjectionMatchSetResponse":{ - "type":"structure", - "members":{ - "SqlInjectionMatchSet":{ - "shape":"SqlInjectionMatchSet", - "documentation":"Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet
request. For more information, see the following topics:
SqlInjectionMatchSet: Contains Name
, SqlInjectionMatchSetId
, and an array of SqlInjectionMatchTuple
objects
SqlInjectionMatchTuple: Each SqlInjectionMatchTuple
object contains FieldToMatch
and TextTransformation
FieldToMatch: Contains Data
and Type
The response to a GetSqlInjectionMatchSet request.
" - }, - "GetWebACLRequest":{ - "type":"structure", - "required":["WebACLId"], - "members":{ - "WebACLId":{ - "shape":"ResourceId", - "documentation":"The WebACLId
of the WebACL that you want to get. WebACLId
is returned by CreateWebACL and by ListWebACLs.
Information about the WebACL that you specified in the GetWebACL
request. For more information, see the following topics:
WebACL: Contains DefaultAction
, MetricName
, Name
, an array of Rule
objects, and WebACLId
DefaultAction
(Data type is WafAction): Contains Type
Rules
: Contains an array of ActivatedRule
objects, which contain Action
, Priority
, and RuleId
Action
: Contains Type
The XssMatchSetId
of the XssMatchSet that you want to get. XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
A request to get an XssMatchSet.
" - }, - "GetXssMatchSetResponse":{ - "type":"structure", - "members":{ - "XssMatchSet":{ - "shape":"XssMatchSet", - "documentation":"Information about the XssMatchSet that you specified in the GetXssMatchSet
request. For more information, see the following topics:
XssMatchSet: Contains Name
, XssMatchSetId
, and an array of XssMatchTuple
objects
XssMatchTuple: Each XssMatchTuple
object contains FieldToMatch
and TextTransformation
FieldToMatch: Contains Data
and Type
The response to a GetXssMatchSet request.
" - }, - "HTTPHeader":{ - "type":"structure", - "members":{ - "Name":{ - "shape":"HeaderName", - "documentation":"The name of one of the headers in the sampled web request.
" - }, - "Value":{ - "shape":"HeaderValue", - "documentation":"The value of one of the headers in the sampled web request.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The response from a GetSampledRequests request includes an HTTPHeader
complex type that appears as Headers
in the response syntax. HTTPHeader
contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests
.
The IP address that the request originated from. If the WebACL
is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:
c-ip
, if the viewer did not use an HTTP proxy or a load balancer to send the request
x-forwarded-for
, if the viewer did use an HTTP proxy or a load balancer to send the request
The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.
" - }, - "URI":{ - "shape":"URIString", - "documentation":"The part of a web request that identifies the resource, for example, /images/daily-ad.jpg
.
The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE
, GET
, HEAD
, OPTIONS
, PATCH
, POST
, and PUT
.
The HTTP version specified in the sampled web request, for example, HTTP/1.1
.
A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The response from a GetSampledRequests request includes an HTTPRequest
complex type that appears as Request
in the response syntax. HTTPRequest
contains information about one of the web requests that were returned by GetSampledRequests
.
The IPSetId
for an IPSet
. You use IPSetId
to get information about an IPSet
(see GetIPSet), update an IPSet
(see UpdateIPSet), insert an IPSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete an IPSet
from AWS WAF (see DeleteIPSet).
IPSetId
is returned by CreateIPSet and by ListIPSets.
A friendly name or description of the IPSet. You can't change the name of an IPSet
after you create it.
The IP address type (IPV4
or IPV6
) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL
is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.
To specify an individual IP address, you specify the four-part IP address followed by a /32
, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Specify IPV4
or IPV6
.
Specify an IPv4 address by using CIDR notation. For example:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32
.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Specify an IPv6 address by using CIDR notation. For example:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128
.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the IP address type (IPV4
or IPV6
) and the IP address range (in CIDR format) that web requests originate from.
The IPSetId
for an IPSet. You can use IPSetId
in a GetIPSet request to get detailed information about an IPSet.
A friendly name or description of the IPSet. You can't change the name of an IPSet
after you create it.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the name of the IPSet
.
Specifies whether to insert or delete an IP address with UpdateIPSet.
" - }, - "IPSetDescriptor":{ - "shape":"IPSetDescriptor", - "documentation":"The IP address type (IPV4
or IPV6
) and the IP address range (in CIDR notation) that web requests originate from.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the type of update to perform to an IPSet with UpdateIPSet.
" - }, - "IPSetUpdates":{ - "type":"list", - "member":{"shape":"IPSetUpdate"}, - "min":1 - }, - "IPString":{"type":"string"}, - "IgnoreUnsupportedType":{"type":"boolean"}, - "ListActivatedRulesInRuleGroupRequest":{ - "type":"structure", - "members":{ - "RuleGroupId":{ - "shape":"ResourceId", - "documentation":"The RuleGroupId
of the RuleGroup for which you want to get a list of ActivatedRule objects.
If you specify a value for Limit
and you have more ActivatedRules
than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of ActivatedRules
. For the second and subsequent ListActivatedRulesInRuleGroup
requests, specify the value of NextMarker
from the previous response to get information about another batch of ActivatedRules
.
Specifies the number of ActivatedRules
that you want AWS WAF to return for this request. If you have more ActivatedRules
than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of ActivatedRules
.
If you have more ActivatedRules
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more ActivatedRules
, submit another ListActivatedRulesInRuleGroup
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of ActivatedRules
objects.
If you specify a value for Limit
and you have more ByteMatchSets
than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of ByteMatchSets
. For the second and subsequent ListByteMatchSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of ByteMatchSets
.
Specifies the number of ByteMatchSet
objects that you want AWS WAF to return for this request. If you have more ByteMatchSets
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of ByteMatchSet
objects.
If you have more ByteMatchSet
objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more ByteMatchSet
objects, submit another ListByteMatchSets
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of ByteMatchSetSummary objects.
" - } - } - }, - "ListGeoMatchSetsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more GeoMatchSet
s than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of GeoMatchSet
objects. For the second and subsequent ListGeoMatchSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of GeoMatchSet
objects.
Specifies the number of GeoMatchSet
objects that you want AWS WAF to return for this request. If you have more GeoMatchSet
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of GeoMatchSet
objects.
If you have more GeoMatchSet
objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more GeoMatchSet
objects, submit another ListGeoMatchSets
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of GeoMatchSetSummary objects.
" - } - } - }, - "ListIPSetsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"AWS WAF returns a NextMarker
value in the response that allows you to list another group of IPSets
. For the second and subsequent ListIPSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of IPSets
.
Specifies the number of IPSet
objects that you want AWS WAF to return for this request. If you have more IPSet
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of IPSet
objects.
To list more IPSet
objects, submit another ListIPSets
request, and in the next request use the NextMarker
response value as the NextMarker
value.
An array of IPSetSummary objects.
" - } - } - }, - "ListLoggingConfigurationsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more LoggingConfigurations
than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of LoggingConfigurations
. For the second and subsequent ListLoggingConfigurations
requests, specify the value of NextMarker
from the previous response to get information about another batch of ListLoggingConfigurations
.
Specifies the number of LoggingConfigurations
that you want AWS WAF to return for this request. If you have more LoggingConfigurations
than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of LoggingConfigurations
.
An array of LoggingConfiguration objects.
" - }, - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you have more LoggingConfigurations
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more LoggingConfigurations
, submit another ListLoggingConfigurations
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
If you specify a value for Limit
and you have more Rules
than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of Rules
. For the second and subsequent ListRateBasedRules
requests, specify the value of NextMarker
from the previous response to get information about another batch of Rules
.
Specifies the number of Rules
that you want AWS WAF to return for this request. If you have more Rules
than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of Rules
.
If you have more Rules
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more Rules
, submit another ListRateBasedRules
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of RuleSummary objects.
" - } - } - }, - "ListRegexMatchSetsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more RegexMatchSet
objects than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of ByteMatchSets
. For the second and subsequent ListRegexMatchSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of RegexMatchSet
objects.
Specifies the number of RegexMatchSet
objects that you want AWS WAF to return for this request. If you have more RegexMatchSet
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of RegexMatchSet
objects.
If you have more RegexMatchSet
objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more RegexMatchSet
objects, submit another ListRegexMatchSets
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of RegexMatchSetSummary objects.
" - } - } - }, - "ListRegexPatternSetsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more RegexPatternSet
objects than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of RegexPatternSet
objects. For the second and subsequent ListRegexPatternSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of RegexPatternSet
objects.
Specifies the number of RegexPatternSet
objects that you want AWS WAF to return for this request. If you have more RegexPatternSet
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of RegexPatternSet
objects.
If you have more RegexPatternSet
objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more RegexPatternSet
objects, submit another ListRegexPatternSets
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of RegexPatternSetSummary objects.
" - } - } - }, - "ListRuleGroupsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more RuleGroups
than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of RuleGroups
. For the second and subsequent ListRuleGroups
requests, specify the value of NextMarker
from the previous response to get information about another batch of RuleGroups
.
Specifies the number of RuleGroups
that you want AWS WAF to return for this request. If you have more RuleGroups
than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of RuleGroups
.
If you have more RuleGroups
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more RuleGroups
, submit another ListRuleGroups
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of RuleGroup objects.
" - } - } - }, - "ListRulesRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more Rules
than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of Rules
. For the second and subsequent ListRules
requests, specify the value of NextMarker
from the previous response to get information about another batch of Rules
.
Specifies the number of Rules
that you want AWS WAF to return for this request. If you have more Rules
than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of Rules
.
If you have more Rules
than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more Rules
, submit another ListRules
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of RuleSummary objects.
" - } - } - }, - "ListSizeConstraintSetsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more SizeConstraintSets
than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of SizeConstraintSets
. For the second and subsequent ListSizeConstraintSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of SizeConstraintSets
.
Specifies the number of SizeConstraintSet
objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of SizeConstraintSet
objects.
If you have more SizeConstraintSet
objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more SizeConstraintSet
objects, submit another ListSizeConstraintSets
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of SizeConstraintSetSummary objects.
" - } - } - }, - "ListSqlInjectionMatchSetsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more SqlInjectionMatchSet objects than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of SqlInjectionMatchSets
. For the second and subsequent ListSqlInjectionMatchSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of SqlInjectionMatchSets
.
Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of Rules
.
A request to list the SqlInjectionMatchSet objects created by the current AWS account.
" - }, - "ListSqlInjectionMatchSetsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you have more SqlInjectionMatchSet objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more SqlInjectionMatchSet
objects, submit another ListSqlInjectionMatchSets
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of SqlInjectionMatchSetSummary objects.
" - } - }, - "documentation":"The response to a ListSqlInjectionMatchSets request.
" - }, - "ListSubscribedRuleGroupsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more ByteMatchSets
subscribed rule groups than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest
requests, specify the value of NextMarker
from the previous response to get information about another batch of subscribed rule groups.
Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of objects.
If you have more objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more objects, submit another ListSubscribedRuleGroups
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of RuleGroup objects.
" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["ResourceARN"], - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"" - }, - "Limit":{ - "shape":"PaginationLimit", - "documentation":"" - }, - "ResourceARN":{ - "shape":"ResourceArn", - "documentation":"" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"" - }, - "TagInfoForResource":{ - "shape":"TagInfoForResource", - "documentation":"" - } - } - }, - "ListWebACLsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more WebACL
objects than the number that you specify for Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of WebACL
objects. For the second and subsequent ListWebACLs
requests, specify the value of NextMarker
from the previous response to get information about another batch of WebACL
objects.
Specifies the number of WebACL
objects that you want AWS WAF to return for this request. If you have more WebACL
objects than the number that you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of WebACL
objects.
If you have more WebACL
objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more WebACL
objects, submit another ListWebACLs
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of WebACLSummary objects.
" - } - } - }, - "ListXssMatchSetsRequest":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you specify a value for Limit
and you have more XssMatchSet objects than the value of Limit
, AWS WAF returns a NextMarker
value in the response that allows you to list another group of XssMatchSets
. For the second and subsequent ListXssMatchSets
requests, specify the value of NextMarker
from the previous response to get information about another batch of XssMatchSets
.
Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet
objects than the number you specify for Limit
, the response includes a NextMarker
value that you can use to get another batch of Rules
.
A request to list the XssMatchSet objects created by the current AWS account.
" - }, - "ListXssMatchSetsResponse":{ - "type":"structure", - "members":{ - "NextMarker":{ - "shape":"NextMarker", - "documentation":"If you have more XssMatchSet objects than the number that you specified for Limit
in the request, the response includes a NextMarker
value. To list more XssMatchSet
objects, submit another ListXssMatchSets
request, and specify the NextMarker
value from the response in the NextMarker
value in the next request.
An array of XssMatchSetSummary objects.
" - } - }, - "documentation":"The response to a ListXssMatchSets request.
" - }, - "LogDestinationConfigs":{ - "type":"list", - "member":{"shape":"ResourceArn"}, - "max":1, - "min":1 - }, - "LoggingConfiguration":{ - "type":"structure", - "required":[ - "ResourceArn", - "LogDestinationConfigs" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs
.
An array of Amazon Kinesis Data Firehose ARNs.
" - }, - "RedactedFields":{ - "shape":"RedactedFields", - "documentation":"The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The Amazon Kinesis Data Firehose, RedactedFields
information, and the web ACL Amazon Resource Name (ARN).
Set Negated
to False
if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet
includes the IP address 192.0.2.44
, AWS WAF will allow or block requests based on that IP address.
Set Negated
to True
if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet
includes the IP address 192.0.2.44
, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44
.
The type of predicate in a Rule
, such as ByteMatch
or IPSet
.
A unique identifier for a predicate in a Rule
, such as ByteMatchSetId
or IPSetId
. The ID is returned by the corresponding Create
or List
command.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule
and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.
The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.
When specifying Type
in RedactedFields
, you must use one of the following values: URI
, QUERY_STRING
, HEADER
, or METHOD
.
The LoggingConfiguration that you submitted in the request.
" - } - } - }, - "PutPermissionPolicyRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Policy" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
" - }, - "Policy":{ - "shape":"PolicyString", - "documentation":"The policy to attach to the specified RuleGroup.
" - } - } - }, - "PutPermissionPolicyResponse":{ - "type":"structure", - "members":{} - }, - "RateBasedRule":{ - "type":"structure", - "required":[ - "RuleId", - "MatchPredicates", - "RateKey", - "RateLimit" - ], - "members":{ - "RuleId":{ - "shape":"ResourceId", - "documentation":"A unique identifier for a RateBasedRule
. You use RuleId
to get more information about a RateBasedRule
(see GetRateBasedRule), update a RateBasedRule
(see UpdateRateBasedRule), insert a RateBasedRule
into a WebACL
or delete one from a WebACL
(see UpdateWebACL), or delete a RateBasedRule
from AWS WAF (see DeleteRateBasedRule).
A friendly name or description for a RateBasedRule
. You can't change the name of a RateBasedRule
after you create it.
A friendly name or description for the metrics for a RateBasedRule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RateBasedRule
.
The Predicates
object contains one Predicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule
.
The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey
is IP
. IP
indicates that requests arriving from the same IP address are subject to the RateLimit
that is specified in the RateBasedRule
.
The maximum number of requests, which have an identical value in the field specified by the RateKey
, allowed in a five-minute period. If the number of requests exceeds the RateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A RateBasedRule
is identical to a regular Rule, with one addition: a RateBasedRule
counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule
that includes the following conditions:
The requests come from 192.0.2.44.
They contain the value BadBot
in the User-Agent
header.
In the rule, you also define the rate limit as 1,000.
Requests that meet both of these conditions and exceed 1,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.
" - }, - "RateKey":{ - "type":"string", - "enum":["IP"] - }, - "RateLimit":{ - "type":"long", - "max":2000000000, - "min":100 - }, - "RedactedFields":{ - "type":"list", - "member":{"shape":"FieldToMatch"} - }, - "RegexMatchSet":{ - "type":"structure", - "members":{ - "RegexMatchSetId":{ - "shape":"ResourceId", - "documentation":"The RegexMatchSetId
for a RegexMatchSet
. You use RegexMatchSetId
to get information about a RegexMatchSet
(see GetRegexMatchSet), update a RegexMatchSet
(see UpdateRegexMatchSet), insert a RegexMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a RegexMatchSet
from AWS WAF (see DeleteRegexMatchSet).
RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a RegexMatchSet
.
Contains an array of RegexMatchTuple objects. Each RegexMatchTuple
object contains:
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In a GetRegexMatchSet request, RegexMatchSet
is a complex type that contains the RegexMatchSetId
and Name
of a RegexMatchSet
, and the values that you specified when you updated the RegexMatchSet
.
The values are contained in a RegexMatchTuple
object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet
contains more than one RegexMatchTuple
object, a request needs to match the settings in only one ByteMatchTuple
to be considered a match.
The RegexMatchSetId
for a RegexMatchSet
. You use RegexMatchSetId
to get information about a RegexMatchSet
, update a RegexMatchSet
, remove a RegexMatchSet
from a Rule
, and delete a RegexMatchSet
from AWS WAF.
RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
A friendly name or description of the RegexMatchSet. You can't change Name
after you create a RegexMatchSet
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returned by ListRegexMatchSets. Each RegexMatchSetSummary
object includes the Name
and RegexMatchSetId
for one RegexMatchSet.
Specifies whether to insert or delete a RegexMatchTuple.
" - }, - "RegexMatchTuple":{ - "shape":"RegexMatchTuple", - "documentation":"Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE
for the value of Action
, the RegexMatchTuple
values must exactly match the values in the RegexMatchTuple
that you want to delete from the RegexMatchSet
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In an UpdateRegexMatchSet request, RegexMatchSetUpdate
specifies whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple
.
Specifies where in a web request to look for the RegexPatternSet
.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet
before inspecting a request for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \\ \" ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\\f, formfeed, decimal 12
\\t, tab, decimal 9
\\n, newline, decimal 10
\\r, carriage return, decimal 13
\\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot;
with \"
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE
if you don't want to perform any text transformations.
The RegexPatternSetId
for a RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
(see GetRegexPatternSet), update a RegexPatternSet
(see UpdateRegexPatternSet), insert a RegexPatternSet
into a RegexMatchSet
or delete one from a RegexMatchSet
(see UpdateRegexMatchSet), and delete an RegexPatternSet
from AWS WAF (see DeleteRegexPatternSet).
RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple
object contains:
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent
header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
The identifier for the RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
, update a RegexPatternSet
, remove a RegexPatternSet
from a RegexMatchSet
, and delete a RegexPatternSet
from AWS WAF.
RegexMatchSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
A friendly name or description of the RegexPatternSet. You can't change Name
after you create a RegexPatternSet
.
Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The RegexPatternSet
specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
. You can then configure AWS WAF to reject those requests.
The RegexPatternSetId
for a RegexPatternSet
. You use RegexPatternSetId
to get information about a RegexPatternSet
, update a RegexPatternSet
, remove a RegexPatternSet
from a RegexMatchSet
, and delete a RegexPatternSet
from AWS WAF.
RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
A friendly name or description of the RegexPatternSet. You can't change Name
after you create a RegexPatternSet
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returned by ListRegexPatternSets. Each RegexPatternSetSummary
object includes the Name
and RegexPatternSetId
for one RegexPatternSet.
Specifies whether to insert or delete a RegexPatternString
.
Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In an UpdateRegexPatternSet request, RegexPatternSetUpdate
specifies whether to insert or delete a RegexPatternString
and includes the settings for the RegexPatternString
.
A unique identifier for a Rule
. You use RuleId
to get more information about a Rule
(see GetRule), update a Rule
(see UpdateRule), insert a Rule
into a WebACL
or delete a one from a WebACL
(see UpdateWebACL), or delete a Rule
from AWS WAF (see DeleteRule).
RuleId
is returned by CreateRule and by ListRules.
The friendly name or description for the Rule
. You can't change the name of a Rule
after you create it.
A friendly name or description for the metrics for this Rule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName
after you create the Rule
.
The Predicates
object contains one Predicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule
that includes the following predicates:
An IPSet
that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
A ByteMatchSet
that causes AWS WAF to search for web requests for which the value of the User-Agent
header is BadBot
.
To match the settings in this Rule
, a request must originate from 192.0.2.44
AND include a User-Agent
header for which the value is BadBot
.
A unique identifier for a RuleGroup
. You use RuleGroupId
to get more information about a RuleGroup
(see GetRuleGroup), update a RuleGroup
(see UpdateRuleGroup), insert a RuleGroup
into a WebACL
or delete a one from a WebACL
(see UpdateWebACL), or delete a RuleGroup
from AWS WAF (see DeleteRuleGroup).
RuleGroupId
is returned by CreateRuleGroup and by ListRuleGroups.
The friendly name or description for the RuleGroup
. You can't change the name of a RuleGroup
after you create it.
A friendly name or description for the metrics for this RuleGroup
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A collection of predefined rules that you can add to a web ACL.
Rule groups are subject to the following limits:
Three rule groups per account. You can request an increase to this limit by contacting customer support.
One rule group per web ACL.
Ten rules per rule group.
A unique identifier for a RuleGroup
. You use RuleGroupId
to get more information about a RuleGroup
(see GetRuleGroup), update a RuleGroup
(see UpdateRuleGroup), insert a RuleGroup
into a WebACL
or delete one from a WebACL
(see UpdateWebACL), or delete a RuleGroup
from AWS WAF (see DeleteRuleGroup).
RuleGroupId
is returned by CreateRuleGroup and by ListRuleGroups.
A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup
after you create it.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the friendly name or description of the RuleGroup
.
Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use DELETE
to remove an ActivatedRule
from a RuleGroup
.
The ActivatedRule
object specifies a Rule
that you want to insert or delete, the priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a web request matches the Rule
(ALLOW
, BLOCK
, or COUNT
).
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies an ActivatedRule
and indicates whether you want to add it to a RuleGroup
or delete it from a RuleGroup
.
A unique identifier for a Rule
. You use RuleId
to get more information about a Rule
(see GetRule), update a Rule
(see UpdateRule), insert a Rule
into a WebACL
or delete one from a WebACL
(see UpdateWebACL), or delete a Rule
from AWS WAF (see DeleteRule).
RuleId
is returned by CreateRule and by ListRules.
A friendly name or description of the Rule. You can't change the name of a Rule
after you create it.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the friendly name or description of the Rule
.
Specify INSERT
to add a Predicate
to a Rule
. Use DELETE
to remove a Predicate
from a Rule
.
The ID of the Predicate
(such as an IPSet
) that you want to add to a Rule
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies a Predicate
(such as an IPSet
) and indicates whether you want to add it to a Rule
or delete it from a Rule
.
A complex type that contains detailed information about the request.
" - }, - "Weight":{ - "shape":"SampleWeight", - "documentation":"A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2
represents roughly twice as many CloudFront web requests as a result that has a weight of 1
.
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
" - }, - "Action":{ - "shape":"Action", - "documentation":"The action for the Rule
that the request matched: ALLOW
, BLOCK
, or COUNT
.
This value is returned if the GetSampledRequests
request specifies the ID of a RuleGroup
rather than the ID of an individual rule. RuleWithinRuleGroup
is the rule within the specified RuleGroup
that matched the request listed in the response.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The response from a GetSampledRequests request includes a SampledHTTPRequests
complex type that appears as SampledRequests
in the response syntax. SampledHTTPRequests
contains one SampledHTTPRequest
object for each web request that is returned by GetSampledRequests
.
Specifies where in a web request to look for the size constraint.
" - }, - "TextTransformation":{ - "shape":"TextTransformation", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
Note that if you choose BODY
for the value of Type
, you must choose NONE
for TextTransformation
because CloudFront forwards only the first 8192 bytes for inspection.
NONE
Specify NONE
if you don't want to perform any text transformations.
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \\ \" ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\\f, formfeed, decimal 12
\\t, tab, decimal 9
\\n, newline, decimal 10
\\r, carriage return, decimal 13
\\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot;
with \"
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
" - }, - "ComparisonOperator":{ - "shape":"ComparisonOperator", - "documentation":"The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size
and FieldToMatch
to build an expression in the form of \"Size
ComparisonOperator
size in bytes of FieldToMatch
\". If that expression is true, the SizeConstraint
is considered to match.
EQ: Used to test if the Size
is equal to the size of the FieldToMatch
NE: Used to test if the Size
is not equal to the size of the FieldToMatch
LE: Used to test if the Size
is less than or equal to the size of the FieldToMatch
LT: Used to test if the Size
is strictly less than the size of the FieldToMatch
GE: Used to test if the Size
is greater than or equal to the size of the FieldToMatch
GT: Used to test if the Size
is strictly greater than the size of the FieldToMatch
The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch
. AWS WAF uses this in combination with ComparisonOperator
and FieldToMatch
to build an expression in the form of \"Size
ComparisonOperator
size in bytes of FieldToMatch
\". If that expression is true, the SizeConstraint
is considered to match.
Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
If you specify URI
for the value of Type
, the / in the URI counts as one character. For example, the URI /logo.jpg
is nine characters long.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size
, ComparisonOperator
, and FieldToMatch
to build an expression in the form of \"Size
ComparisonOperator
size in bytes of FieldToMatch
\". If that expression is true, the SizeConstraint
is considered to match.
A unique identifier for a SizeConstraintSet
. You use SizeConstraintSetId
to get information about a SizeConstraintSet
(see GetSizeConstraintSet), update a SizeConstraintSet
(see UpdateSizeConstraintSet), insert a SizeConstraintSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a SizeConstraintSet
from AWS WAF (see DeleteSizeConstraintSet).
SizeConstraintSetId
is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The name, if any, of the SizeConstraintSet
.
Specifies the parts of web requests that you want to inspect the size of.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A complex type that contains SizeConstraint
objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet
contains more than one SizeConstraint
object, a request only needs to match one constraint to be considered a match.
A unique identifier for a SizeConstraintSet
. You use SizeConstraintSetId
to get information about a SizeConstraintSet
(see GetSizeConstraintSet), update a SizeConstraintSet
(see UpdateSizeConstraintSet), insert a SizeConstraintSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a SizeConstraintSet
from AWS WAF (see DeleteSizeConstraintSet).
SizeConstraintSetId
is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The name of the SizeConstraintSet
, if any.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The Id
and Name
of a SizeConstraintSet
.
Specify INSERT
to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE
to remove a SizeConstraintSetUpdate
from a SizeConstraintSet
.
Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size
, ComparisonOperator
, and FieldToMatch
to build an expression in the form of \"Size
ComparisonOperator
size in bytes of FieldToMatch
\". If that expression is true, the SizeConstraint
is considered to match.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet
.
A unique identifier for a SqlInjectionMatchSet
. You use SqlInjectionMatchSetId
to get information about a SqlInjectionMatchSet
(see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet
(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a SqlInjectionMatchSet
from AWS WAF (see DeleteSqlInjectionMatchSet).
SqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The name, if any, of the SqlInjectionMatchSet
.
Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A complex type that contains SqlInjectionMatchTuple
objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet
contains more than one SqlInjectionMatchTuple
object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.
A unique identifier for a SqlInjectionMatchSet
. You use SqlInjectionMatchSetId
to get information about a SqlInjectionMatchSet
(see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet
(see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete a SqlInjectionMatchSet
from AWS WAF (see DeleteSqlInjectionMatchSet).
SqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The name of the SqlInjectionMatchSet
, if any, specified by Id
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The Id
and Name
of a SqlInjectionMatchSet
.
Specify INSERT
to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE
to remove a SqlInjectionMatchSetUpdate
from a SqlInjectionMatchSet
.
Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet
.
Specifies where in a web request to look for snippets of malicious SQL code.
" - }, - "TextTransformation":{ - "shape":"TextTransformation", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \\ \" ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\\f, formfeed, decimal 12
\\t, tab, decimal 9
\\n, newline, decimal 10
\\r, carriage return, decimal 13
\\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot;
with \"
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE
if you don't want to perform any text transformations.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
" - }, - "SqlInjectionMatchTuples":{ - "type":"list", - "member":{"shape":"SqlInjectionMatchTuple"} - }, - "SubscribedRuleGroupSummaries":{ - "type":"list", - "member":{"shape":"SubscribedRuleGroupSummary"} - }, - "SubscribedRuleGroupSummary":{ - "type":"structure", - "required":[ - "RuleGroupId", - "Name", - "MetricName" - ], - "members":{ - "RuleGroupId":{ - "shape":"ResourceId", - "documentation":"A unique identifier for a RuleGroup
.
A friendly name or description of the RuleGroup
. You can't change the name of a RuleGroup
after you create it.
A friendly name or description for the metrics for this RuleGroup
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A summary of the rule groups you are subscribed to.
" - }, - "Tag":{ - "type":"structure", - "required":[ - "Key", - "Value" - ], - "members":{ - "Key":{ - "shape":"TagKey", - "documentation":"" - }, - "Value":{ - "shape":"TagValue", - "documentation":"" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" - }, - "TagInfoForResource":{ - "type":"structure", - "members":{ - "ResourceARN":{ - "shape":"ResourceArn", - "documentation":"" - }, - "TagList":{ - "shape":"TagList", - "documentation":"" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Information for a tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.
" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":".*\\S.*" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "min":1 - }, - "TagList":{ - "type":"list", - "member":{"shape":"Tag"}, - "min":1 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceARN", - "Tags" - ], - "members":{ - "ResourceARN":{ - "shape":"ResourceArn", - "documentation":"" - }, - "Tags":{ - "shape":"TagList", - "documentation":"" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":".*" - }, - "TextTransformation":{ - "type":"string", - "enum":[ - "NONE", - "COMPRESS_WHITE_SPACE", - "HTML_ENTITY_DECODE", - "LOWERCASE", - "CMD_LINE", - "URL_DECODE" - ] - }, - "TimeWindow":{ - "type":"structure", - "required":[ - "StartTime", - "EndTime" - ], - "members":{ - "StartTime":{ - "shape":"Timestamp", - "documentation":"The beginning of the time range from which you want GetSampledRequests
to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z
. For example, \"2016-09-27T14:50Z\"
. You can specify any time range in the previous three hours.
The end of the time range from which you want GetSampledRequests
to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z
. For example, \"2016-09-27T14:50Z\"
. You can specify any time range in the previous three hours.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
In a GetSampledRequests request, the StartTime
and EndTime
objects specify the time range for which you want AWS WAF to return a sample of web requests.
You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z
. For example, \"2016-09-27T14:50Z\"
.
In a GetSampledRequests response, the StartTime
and EndTime
objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime
is the time that AWS WAF received the 5,000th request.
The ByteMatchSetId
of the ByteMatchSet that you want to update. ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"ByteMatchSetUpdates", - "documentation":"An array of ByteMatchSetUpdate
objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:
ByteMatchSetUpdate: Contains Action
and ByteMatchTuple
ByteMatchTuple: Contains FieldToMatch
, PositionalConstraint
, TargetString
, and TextTransformation
FieldToMatch: Contains Data
and Type
The ChangeToken
that you used to submit the UpdateByteMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The GeoMatchSetId
of the GeoMatchSet that you want to update. GeoMatchSetId
is returned by CreateGeoMatchSet and by ListGeoMatchSets.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"GeoMatchSetUpdates", - "documentation":"An array of GeoMatchSetUpdate
objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:
GeoMatchSetUpdate: Contains Action
and GeoMatchConstraint
GeoMatchConstraint: Contains Type
and Value
You can have only one Type
and Value
per GeoMatchConstraint
. To add multiple countries, include multiple GeoMatchSetUpdate
objects in your request.
The ChangeToken
that you used to submit the UpdateGeoMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The IPSetId
of the IPSet that you want to update. IPSetId
is returned by CreateIPSet and by ListIPSets.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"IPSetUpdates", - "documentation":"An array of IPSetUpdate
objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:
IPSetUpdate: Contains Action
and IPSetDescriptor
IPSetDescriptor: Contains Type
and Value
You can insert a maximum of 1000 addresses in a single request.
" - } - } - }, - "UpdateIPSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the UpdateIPSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RuleId
of the RateBasedRule
that you want to update. RuleId
is returned by CreateRateBasedRule
and by ListRateBasedRules.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"RuleUpdates", - "documentation":"An array of RuleUpdate
objects that you want to insert into or delete from a RateBasedRule.
The maximum number of requests, which have an identical value in the field specified by the RateKey
, allowed in a five-minute period. If the number of requests exceeds the RateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
The ChangeToken
that you used to submit the UpdateRateBasedRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RegexMatchSetId
of the RegexMatchSet that you want to update. RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
An array of RegexMatchSetUpdate
objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "UpdateRegexMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the UpdateRegexMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RegexPatternSetId
of the RegexPatternSet that you want to update. RegexPatternSetId
is returned by CreateRegexPatternSet and by ListRegexPatternSets.
An array of RegexPatternSetUpdate
objects that you want to insert into or delete from a RegexPatternSet.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "UpdateRegexPatternSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the UpdateRegexPatternSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RuleGroupId
of the RuleGroup that you want to update. RuleGroupId
is returned by CreateRuleGroup and by ListRuleGroups.
An array of RuleGroupUpdate
objects that you want to insert into or delete from a RuleGroup.
You can only insert REGULAR
rules into a rule group.
ActivatedRule|OverrideAction
applies only when updating or adding a RuleGroup
to a WebACL
. In this case you do not use ActivatedRule|Action
. For all other update requests, ActivatedRule|Action
is used instead of ActivatedRule|OverrideAction
.
The value returned by the most recent call to GetChangeToken.
" - } - } - }, - "UpdateRuleGroupResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the UpdateRuleGroup
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The RuleId
of the Rule
that you want to update. RuleId
is returned by CreateRule
and by ListRules.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"RuleUpdates", - "documentation":"An array of RuleUpdate
objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:
RuleUpdate: Contains Action
and Predicate
Predicate: Contains DataId
, Negated
, and Type
FieldToMatch: Contains Data
and Type
The ChangeToken
that you used to submit the UpdateRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The SizeConstraintSetId
of the SizeConstraintSet that you want to update. SizeConstraintSetId
is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"SizeConstraintSetUpdates", - "documentation":"An array of SizeConstraintSetUpdate
objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:
SizeConstraintSetUpdate: Contains Action
and SizeConstraint
SizeConstraint: Contains FieldToMatch
, TextTransformation
, ComparisonOperator
, and Size
FieldToMatch: Contains Data
and Type
The ChangeToken
that you used to submit the UpdateSizeConstraintSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The SqlInjectionMatchSetId
of the SqlInjectionMatchSet
that you want to update. SqlInjectionMatchSetId
is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"SqlInjectionMatchSetUpdates", - "documentation":"An array of SqlInjectionMatchSetUpdate
objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:
SqlInjectionMatchSetUpdate: Contains Action
and SqlInjectionMatchTuple
SqlInjectionMatchTuple: Contains FieldToMatch
and TextTransformation
FieldToMatch: Contains Data
and Type
A request to update a SqlInjectionMatchSet.
" - }, - "UpdateSqlInjectionMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the UpdateSqlInjectionMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The response to an UpdateSqlInjectionMatchSets request.
" - }, - "UpdateWebACLRequest":{ - "type":"structure", - "required":[ - "WebACLId", - "ChangeToken" - ], - "members":{ - "WebACLId":{ - "shape":"ResourceId", - "documentation":"The WebACLId
of the WebACL that you want to update. WebACLId
is returned by CreateWebACL and by ListWebACLs.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"WebACLUpdates", - "documentation":"An array of updates to make to the WebACL.
An array of WebACLUpdate
objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:
WebACLUpdate: Contains Action
and ActivatedRule
ActivatedRule: Contains Action
, OverrideAction
, Priority
, RuleId
, and Type
. ActivatedRule|OverrideAction
applies only when updating or adding a RuleGroup
to a WebACL
. In this case, you do not use ActivatedRule|Action
. For all other update requests, ActivatedRule|Action
is used instead of ActivatedRule|OverrideAction
.
WafAction: Contains Type
A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.
" - } - } - }, - "UpdateWebACLResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the UpdateWebACL
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The XssMatchSetId
of the XssMatchSet
that you want to update. XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The value returned by the most recent call to GetChangeToken.
" - }, - "Updates":{ - "shape":"XssMatchSetUpdates", - "documentation":"An array of XssMatchSetUpdate
objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action
and XssMatchTuple
XssMatchTuple: Contains FieldToMatch
and TextTransformation
FieldToMatch: Contains Data
and Type
A request to update an XssMatchSet.
" - }, - "UpdateXssMatchSetResponse":{ - "type":"structure", - "members":{ - "ChangeToken":{ - "shape":"ChangeToken", - "documentation":"The ChangeToken
that you used to submit the UpdateXssMatchSet
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
The response to an UpdateXssMatchSets request.
" - }, - "WAFBadRequestException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"", - "exception":true - }, - "WAFDisallowedNameException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The name specified is invalid.
", - "exception":true - }, - "WAFEntityMigrationException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"}, - "MigrationErrorType":{"shape":"MigrationErrorType"}, - "MigrationErrorReason":{"shape":"ErrorReason"} - }, - "documentation":"The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType
:
ENTITY_NOT_SUPPORTED
- The web ACL has an unsupported entity but the IgnoreUnsupportedType
is not set to true.
ENTITY_NOT_FOUND
- The web ACL doesn't exist.
S3_BUCKET_NO_PERMISSION
- You don't have permission to perform the PutObject
action to the specified Amazon S3 bucket.
S3_BUCKET_NOT_ACCESSIBLE
- The bucket policy doesn't allow AWS WAF to perform the PutObject
action in the bucket.
S3_BUCKET_NOT_FOUND
- The S3 bucket doesn't exist.
S3_BUCKET_INVALID_REGION
- The S3 bucket is not in the same Region as the web ACL.
S3_INTERNAL_ERROR
- AWS WAF failed to create the template in the S3 bucket for another reason.
The operation failed because of a system problem, even though the request was valid. Retry your request.
", - "exception":true, - "fault":true - }, - "WAFInvalidAccountException":{ - "type":"structure", - "members":{}, - "documentation":"The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
", - "exception":true - }, - "WAFInvalidOperationException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The operation failed because there was nothing to do. For example:
You tried to remove a Rule
from a WebACL
, but the Rule
isn't in the specified WebACL
.
You tried to remove an IP address from an IPSet
, but the IP address isn't in the specified IPSet
.
You tried to remove a ByteMatchTuple
from a ByteMatchSet
, but the ByteMatchTuple
isn't in the specified WebACL
.
You tried to add a Rule
to a WebACL
, but the Rule
already exists in the specified WebACL
.
You tried to add a ByteMatchTuple
to a ByteMatchSet
, but the ByteMatchTuple
already exists in the specified WebACL
.
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
You specified an invalid parameter name.
You specified an invalid value.
You tried to update an object (ByteMatchSet
, IPSet
, Rule
, or WebACL
) using an action other than INSERT
or DELETE
.
You tried to create a WebACL
with a DefaultAction
Type
other than ALLOW
, BLOCK
, or COUNT
.
You tried to create a RateBasedRule
with a RateKey
value other than IP
.
You tried to update a WebACL
with a WafAction
Type
other than ALLOW
, BLOCK
, or COUNT
.
You tried to update a ByteMatchSet
with a FieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY.
You tried to update a ByteMatchSet
with a Field
of HEADER
but no value for Data
.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
The operation failed because the specified policy is not in the proper format.
The policy is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy
request.
The policy must include an Effect
, Action
and Principal
.
Effect
must specify Allow
.
The Action
in the policy must be waf:UpdateWebACL
, waf-regional:UpdateWebACL
, waf:GetRuleGroup
and waf-regional:GetRuleGroup
. Any extra or wildcard actions in the policy will be rejected.
The policy cannot include a Resource
parameter.
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
The user making the request must be the owner of the RuleGroup.
Your policy must be composed using IAM Policy version 2012-10-17.
The regular expression (regex) you specified in RegexPatternString
is invalid.
The operation exceeds a resource limit, for example, the maximum number of WebACL
objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
The operation failed because you tried to delete an object that isn't empty. For example:
You tried to delete a WebACL
that still contains one or more Rule
objects.
You tried to delete a Rule
that still contains one or more ByteMatchSet
objects or other predicates.
You tried to delete a ByteMatchSet
that contains one or more ByteMatchTuple
objects.
You tried to delete an IPSet
that references one or more IP addresses.
The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:
You tried to add a Rule
to or delete a Rule
from a WebACL
that doesn't exist.
You tried to add a ByteMatchSet
to or delete a ByteMatchSet
from a Rule
that doesn't exist.
You tried to add an IP address to or delete an IP address from an IPSet
that doesn't exist.
You tried to add a ByteMatchTuple
to or delete a ByteMatchTuple
from a ByteMatchSet
that doesn't exist.
The operation failed because the referenced object doesn't exist.
", - "exception":true - }, - "WAFReferencedItemException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet
that is still referenced by a Rule
.
You tried to delete a Rule
that is still referenced by a WebACL
.
AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration
request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole
, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.
", - "exception":true - }, - "WAFSubscriptionNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"The specified subscription does not exist.
", - "exception":true - }, - "WAFTagOperationException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"", - "exception":true - }, - "WAFTagOperationInternalErrorException":{ - "type":"structure", - "members":{ - "message":{"shape":"errorMessage"} - }, - "documentation":"", - "exception":true, - "fault":true - }, - "WafAction":{ - "type":"structure", - "required":["Type"], - "members":{ - "Type":{ - "shape":"WafActionType", - "documentation":"Specifies how you want AWS WAF to respond to requests that match the settings in a Rule
. Valid settings include the following:
ALLOW
: AWS WAF allows requests
BLOCK
: AWS WAF blocks requests
COUNT
: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT
for the default action for a WebACL
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
For the action that is associated with a rule in a WebACL
, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL
, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL
.
COUNT
overrides the action specified by the individual rule within a RuleGroup
. If set to NONE
, the rule's action will take place.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The action to take if any rule within the RuleGroup
matches a request.
A unique identifier for a WebACL
. You use WebACLId
to get information about a WebACL
(see GetWebACL), update a WebACL
(see UpdateWebACL), and delete a WebACL
from AWS WAF (see DeleteWebACL).
WebACLId
is returned by CreateWebACL and by ListWebACLs.
A friendly name or description of the WebACL
. You can't change the name of a WebACL
after you create it.
A friendly name or description for the metrics for this WebACL
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName
after you create the WebACL
.
The action to perform if none of the Rules
contained in the WebACL
match. The action is specified by the WafAction object.
An array that contains the action for each Rule
in a WebACL
, the priority of the Rule
, and the ID of the Rule
.
Tha Amazon Resource Name (ARN) of the web ACL.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the Rules
that identify the requests that you want to allow, block, or count. In a WebACL
, you also specify a default action (ALLOW
or BLOCK
), and the action for each Rule
that you add to a WebACL
, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL
with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule
to a WebACL
, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.
A unique identifier for a WebACL
. You use WebACLId
to get information about a WebACL
(see GetWebACL), update a WebACL
(see UpdateWebACL), and delete a WebACL
from AWS WAF (see DeleteWebACL).
WebACLId
is returned by CreateWebACL and by ListWebACLs.
A friendly name or description of the WebACL. You can't change the name of a WebACL
after you create it.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Contains the identifier and the name or description of the WebACL.
" - }, - "WebACLUpdate":{ - "type":"structure", - "required":[ - "Action", - "ActivatedRule" - ], - "members":{ - "Action":{ - "shape":"ChangeAction", - "documentation":"Specifies whether to insert a Rule
into or delete a Rule
from a WebACL
.
The ActivatedRule
object in an UpdateWebACL request specifies a Rule
that you want to insert or delete, the priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a web request matches the Rule
(ALLOW
, BLOCK
, or COUNT
).
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies whether to insert a Rule
into or delete a Rule
from a WebACL
.
A unique identifier for an XssMatchSet
. You use XssMatchSetId
to get information about an XssMatchSet
(see GetXssMatchSet), update an XssMatchSet
(see UpdateXssMatchSet), insert an XssMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete an XssMatchSet
from AWS WAF (see DeleteXssMatchSet).
XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The name, if any, of the XssMatchSet
.
Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A complex type that contains XssMatchTuple
objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet
contains more than one XssMatchTuple
object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.
A unique identifier for an XssMatchSet
. You use XssMatchSetId
to get information about a XssMatchSet
(see GetXssMatchSet), update an XssMatchSet
(see UpdateXssMatchSet), insert an XssMatchSet
into a Rule
or delete one from a Rule
(see UpdateRule), and delete an XssMatchSet
from AWS WAF (see DeleteXssMatchSet).
XssMatchSetId
is returned by CreateXssMatchSet and by ListXssMatchSets.
The name of the XssMatchSet
, if any, specified by Id
.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
The Id
and Name
of an XssMatchSet
.
Specify INSERT
to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE
to remove an XssMatchSetUpdate
from an XssMatchSet
.
Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
" - } - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet
.
Specifies where in a web request to look for cross-site scripting attacks.
" - }, - "TextTransformation":{ - "shape":"TextTransformation", - "documentation":"Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting it for a match.
You can only specify a single type of TextTransformation.
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \\ \" ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\\f, formfeed, decimal 12
\\t, tab, decimal 9
\\n, newline, decimal 10
\\r, carriage return, decimal 13
\\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE
also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot;
with \"
Replaces (ampersand)nbsp;
with a non-breaking space, decimal 160
Replaces (ampersand)lt;
with a \"less than\" symbol
Replaces (ampersand)gt;
with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;
, with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;
, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE
if you don't want to perform any text transformations.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
" - }, - "XssMatchTuples":{ - "type":"list", - "member":{"shape":"XssMatchTuple"} - }, - "errorMessage":{"type":"string"} - }, - "documentation":"This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide.
" -} diff --git a/awscli/examples/qldb/cancel-journal-kinesis-stream.rst b/awscli/examples/qldb/cancel-journal-kinesis-stream.rst deleted file mode 100644 index 75a499b41d4f..000000000000 --- a/awscli/examples/qldb/cancel-journal-kinesis-stream.rst +++ /dev/null @@ -1,15 +0,0 @@ -**To cancel a journal stream** - -The following ``cancel-journal-kinesis-stream`` example cancels the specified journal stream from a ledger. :: - - aws qldb cancel-journal-kinesis-stream \ - --ledger-name myExampleLedger \ - --stream-id 7ISCkqwe4y25YyHLzYUFAf - -Output:: - - { - "StreamId": "7ISCkqwe4y25YyHLzYUFAf" - } - -For more information, see `Streaming journal data from Amazon QLDB