The names of one or more AWS accounts for which you want to deploy stack set updates.
" }, + "AccountsUrl":{"shape":"AccountsUrl"}, "OrganizationalUnitIds":{ "shape":"OrganizationalUnitIdList", "documentation":"The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
" @@ -3447,6 +3454,13 @@ "type":"string", "pattern":"^[a-zA-Z0-9-]{1,128}$" }, + "RegionConcurrencyType":{ + "type":"string", + "enum":[ + "SEQUENTIAL", + "PARALLEL" + ] + }, "RegionList":{ "type":"list", "member":{"shape":"Region"} @@ -4803,6 +4817,7 @@ "StackSetOperationPreferences":{ "type":"structure", "members":{ + "RegionConcurrencyType":{"shape":"RegionConcurrencyType"}, "RegionOrder":{ "shape":"RegionList", "documentation":"The order of the Regions in where you want to perform the stack operation.
" From 206e97824d6902a258487998681df24836013aac Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:02 +0000 Subject: [PATCH 03/19] AWS Batch Update: AWS Batch adds support for Amazon EFS File System --- .../feature-AWSBatch-a5021fe.json | 6 ++ .../codegen-resources/service-2.json | 69 +++++++++++++++++-- 2 files changed, 70 insertions(+), 5 deletions(-) create mode 100644 .changes/next-release/feature-AWSBatch-a5021fe.json diff --git a/.changes/next-release/feature-AWSBatch-a5021fe.json b/.changes/next-release/feature-AWSBatch-a5021fe.json new file mode 100644 index 000000000000..5c9150a156e6 --- /dev/null +++ b/.changes/next-release/feature-AWSBatch-a5021fe.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Batch", + "contributor": "", + "description": "AWS Batch adds support for Amazon EFS File System" +} diff --git a/services/batch/src/main/resources/codegen-resources/service-2.json b/services/batch/src/main/resources/codegen-resources/service-2.json index 2344cba524e9..e0bfc06d058c 100644 --- a/services/batch/src/main/resources/codegen-resources/service-2.json +++ b/services/batch/src/main/resources/codegen-resources/service-2.json @@ -1202,20 +1202,75 @@ "type":"list", "member":{"shape":"Device"} }, + "EFSAuthorizationConfig":{ + "type":"structure", + "members":{ + "accessPointId":{ + "shape":"String", + "documentation":"The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.
Whether or not to use the AWS Batch execution IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the AWS Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.
The authorization configuration details for the Amazon EFS file system.
" + }, + "EFSAuthorizationConfigIAM":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "EFSTransitEncryption":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "EFSVolumeConfiguration":{ + "type":"structure", + "required":["fileSystemId"], + "members":{ + "fileSystemId":{ + "shape":"String", + "documentation":"The Amazon EFS file system ID to use.
" + }, + "rootDirectory":{ + "shape":"String", + "documentation":"The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the Amazon EFS access point.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
" + }, + "authorizationConfig":{ + "shape":"EFSAuthorizationConfig", + "documentation":"The authorization configuration details for the Amazon EFS file system.
" + } + }, + "documentation":"This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the AWS Batch User Guide.
" + }, "Ec2Configuration":{ "type":"structure", "required":["imageType"], "members":{ "imageType":{ "shape":"ImageType", - "documentation":"The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized AMI is used.
Amazon Linux 2− Default for all AWS Graviton-based instance families (for example, C6g, M6g, R6g, and T4g) and can be used for all non-GPU instance types.
Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non-AWS Graviton-based instance types.
Amazon Linux−Default for all non-GPU, non-AWS Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized AMI (ECS_AL1) is used. Starting on March 31, 2021, this default will be changing to ECS_AL2 (Amazon Linux 2).
Amazon Linux 2− Default for all AWS Graviton-based instance families (for example, C6g, M6g, R6g, and T4g) and can be used for all non-GPU instance types.
Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non-AWS Graviton-based instance types.
Amazon Linux−Default for all non-GPU, non-AWS Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If the Ec2Configuration isn't specified, the default is ECS_AL1.
This object isn't applicable to jobs running on Fargate resources.
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is currently ECS_AL1 (Amazon Linux) for non-GPU, non-Graviton instances. Starting on March 31, 2021, this default will be changing to ECS_AL2 (Amazon Linux 2).
This object isn't applicable to jobs running on Fargate resources.
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.
Default: $Default.
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.
After the compute environment is created, the launch template version used will not be changed, even if the $Default or $Latest version for the launch template is updated. To use a new launch template version, create a new compute environment, add the new compute environment to the existing job queue, remove the old compute environment from the job queue, and delete the old compute environment.
Default: $Default.
An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.
If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.
This object isn't applicable to jobs running on Fargate resources.
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.
Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.
If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.
Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
Contains the parameters for UpdateComputeEnvironment.
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs running on Fargate resources must specify a platformVersion of at least 1.4.0.
A data volume used in a job's container properties.
" @@ -2454,5 +2513,5 @@ "member":{"shape":"Volume"} } }, - "documentation":"Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.
As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.
" + "documentation":"Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.
As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.
" } From 14c1fa0cd72adef1a9543148085fce094fa9c2b2 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:02 +0000 Subject: [PATCH 04/19] AWS Data Pipeline Update: Minor documentation updates and link updates. --- .../feature-AWSDataPipeline-23bdeb0.json | 6 + .../codegen-resources/paginators-1.json | 18 +- .../codegen-resources/service-2.json | 681 ++++-------------- 3 files changed, 150 insertions(+), 555 deletions(-) create mode 100644 .changes/next-release/feature-AWSDataPipeline-23bdeb0.json diff --git a/.changes/next-release/feature-AWSDataPipeline-23bdeb0.json b/.changes/next-release/feature-AWSDataPipeline-23bdeb0.json new file mode 100644 index 000000000000..786454e0dddd --- /dev/null +++ b/.changes/next-release/feature-AWSDataPipeline-23bdeb0.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Data Pipeline", + "contributor": "", + "description": "Minor documentation updates and link updates." +} diff --git a/services/datapipeline/src/main/resources/codegen-resources/paginators-1.json b/services/datapipeline/src/main/resources/codegen-resources/paginators-1.json index 9cd64426c36c..00df321bcd91 100644 --- a/services/datapipeline/src/main/resources/codegen-resources/paginators-1.json +++ b/services/datapipeline/src/main/resources/codegen-resources/paginators-1.json @@ -1,25 +1,25 @@ { "pagination": { - "ListPipelines": { - "input_token": "marker", - "output_token": "marker", - "more_results": "hasMoreResults", - "result_key": "pipelineIdList" - }, "DescribeObjects": { "input_token": "marker", - "output_token": "marker", "more_results": "hasMoreResults", + "output_token": "marker", "result_key": "pipelineObjects" }, "DescribePipelines": { "result_key": "pipelineDescriptionList" }, - "QueryObjects": { + "ListPipelines": { "input_token": "marker", - "output_token": "marker", "more_results": "hasMoreResults", + "output_token": "marker", + "result_key": "pipelineIdList" + }, + "QueryObjects": { + "input_token": "marker", "limit_key": "limit", + "more_results": "hasMoreResults", + "output_token": "marker", "result_key": "ids" } } diff --git a/services/datapipeline/src/main/resources/codegen-resources/service-2.json b/services/datapipeline/src/main/resources/codegen-resources/service-2.json index 55298952574f..9a73a44e0c7f 100644 --- a/services/datapipeline/src/main/resources/codegen-resources/service-2.json +++ b/services/datapipeline/src/main/resources/codegen-resources/service-2.json @@ -4,14 +4,13 @@ "apiVersion":"2012-10-29", "endpointPrefix":"datapipeline", "jsonVersion":"1.1", + "protocol":"json", "serviceFullName":"AWS Data Pipeline", "serviceId":"Data Pipeline", "signatureVersion":"v4", "targetPrefix":"DataPipeline", - "protocol":"json", "uid":"datapipeline-2012-10-29" }, - "documentation":"AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.
AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.
AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.
", "operations":{ "ActivatePipeline":{ "name":"ActivatePipeline", @@ -19,36 +18,13 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"ActivatePipelineInput", - "documentation":"Contains the parameters for ActivatePipeline.
" - }, - "output":{ - "shape":"ActivatePipelineOutput", - "documentation":"Contains the output of ActivatePipeline.
" - }, + "input":{"shape":"ActivatePipelineInput"}, + "output":{"shape":"ActivatePipelineOutput"}, "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.
If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.
To activate a finished pipeline, modify the end date for the pipeline and then activate it.
" }, @@ -58,36 +34,13 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"AddTagsInput", - "documentation":"Contains the parameters for AddTags.
" - }, - "output":{ - "shape":"AddTagsOutput", - "documentation":"Contains the output of AddTags.
" - }, + "input":{"shape":"AddTagsInput"}, + "output":{"shape":"AddTagsOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Adds or modifies tags for the specified pipeline.
" }, @@ -97,26 +50,11 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"CreatePipelineInput", - "documentation":"Contains the parameters for CreatePipeline.
" - }, - "output":{ - "shape":"CreatePipelineOutput", - "documentation":"Contains the output of CreatePipeline.
" - }, + "input":{"shape":"CreatePipelineInput"}, + "output":{"shape":"CreatePipelineOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
" }, @@ -126,36 +64,13 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"DeactivatePipelineInput", - "documentation":"Contains the parameters for DeactivatePipeline.
" - }, - "output":{ - "shape":"DeactivatePipelineOutput", - "documentation":"Contains the output of DeactivatePipeline.
" - }, + "input":{"shape":"DeactivatePipelineInput"}, + "output":{"shape":"DeactivatePipelineOutput"}, "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.
To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.
" }, @@ -165,27 +80,11 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"DeletePipelineInput", - "documentation":"Contains the parameters for DeletePipeline.
" - }, + "input":{"shape":"DeletePipelineInput"}, "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"PipelineNotFoundException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.
Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.
Contains the parameters for DescribeObjects.
" - }, - "output":{ - "shape":"DescribeObjectsOutput", - "documentation":"Contains the output of DescribeObjects.
" - }, + "input":{"shape":"DescribeObjectsInput"}, + "output":{"shape":"DescribeObjectsOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
" }, @@ -234,36 +110,13 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"DescribePipelinesInput", - "documentation":"Contains the parameters for DescribePipelines.
" - }, - "output":{ - "shape":"DescribePipelinesOutput", - "documentation":"Contains the output of DescribePipelines.
" - }, + "input":{"shape":"DescribePipelinesInput"}, + "output":{"shape":"DescribePipelinesOutput"}, "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.
To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.
" }, @@ -273,41 +126,14 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"EvaluateExpressionInput", - "documentation":"Contains the parameters for EvaluateExpression.
" - }, - "output":{ - "shape":"EvaluateExpressionOutput", - "documentation":"Contains the output of EvaluateExpression.
" - }, + "input":{"shape":"EvaluateExpressionInput"}, + "output":{"shape":"EvaluateExpressionOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"TaskNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.
Contains the parameters for GetPipelineDefinition.
" - }, - "output":{ - "shape":"GetPipelineDefinitionOutput", - "documentation":"Contains the output of GetPipelineDefinition.
" - }, + "input":{"shape":"GetPipelineDefinitionInput"}, + "output":{"shape":"GetPipelineDefinitionOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.
Contains the parameters for ListPipelines.
" - }, - "output":{ - "shape":"ListPipelinesOutput", - "documentation":"Contains the output of ListPipelines.
" - }, + "input":{"shape":"ListPipelinesInput"}, + "output":{"shape":"ListPipelinesOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Lists the pipeline identifiers for all active pipelines that you have permission to access.
" }, @@ -385,31 +173,12 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"PollForTaskInput", - "documentation":"Contains the parameters for PollForTask.
" - }, - "output":{ - "shape":"PollForTaskOutput", - "documentation":"Contains the output of PollForTask.
" - }, + "input":{"shape":"PollForTaskInput"}, + "output":{"shape":"PollForTaskOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"TaskNotFoundException"} ], "documentation":"Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.
If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.
Contains the parameters for PutPipelineDefinition.
" - }, - "output":{ - "shape":"PutPipelineDefinitionOutput", - "documentation":"Contains the output of PutPipelineDefinition.
" - }, + "input":{"shape":"PutPipelineDefinitionInput"}, + "output":{"shape":"PutPipelineDefinitionOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.
PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
Contains the parameters for QueryObjects.
" - }, - "output":{ - "shape":"QueryObjectsOutput", - "documentation":"Contains the output of QueryObjects.
" - }, + "input":{"shape":"QueryObjectsInput"}, + "output":{"shape":"QueryObjectsOutput"}, "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Queries the specified pipeline for the names of objects that match the specified set of conditions.
" }, @@ -497,36 +220,13 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"RemoveTagsInput", - "documentation":"Contains the parameters for RemoveTags.
" - }, - "output":{ - "shape":"RemoveTagsOutput", - "documentation":"Contains the output of RemoveTags.
" - }, + "input":{"shape":"RemoveTagsInput"}, + "output":{"shape":"RemoveTagsOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Removes existing tags from the specified pipeline.
" }, @@ -536,41 +236,14 @@ "method":"POST", "requestUri":"/" }, - "input":{ - "shape":"ReportTaskProgressInput", - "documentation":"Contains the parameters for ReportTaskProgress.
" - }, - "output":{ - "shape":"ReportTaskProgressOutput", - "documentation":"Contains the output of ReportTaskProgress.
" - }, + "input":{"shape":"ReportTaskProgressInput"}, + "output":{"shape":"ReportTaskProgressOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"TaskNotFoundException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.
If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.
Contains the parameters for ReportTaskRunnerHeartbeat.
" - }, - "output":{ - "shape":"ReportTaskRunnerHeartbeatOutput", - "documentation":"Contains the output of ReportTaskRunnerHeartbeat.
" - }, + "input":{"shape":"ReportTaskRunnerHeartbeatInput"}, + "output":{"shape":"ReportTaskRunnerHeartbeatOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.
Contains the parameters for SetStatus.
" - }, + "input":{"shape":"SetStatusInput"}, "errors":[ - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - }, - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - } + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} ], "documentation":"Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.
Contains the parameters for SetTaskStatus.
" - }, - "output":{ - "shape":"SetTaskStatusOutput", - "documentation":"Contains the output of SetTaskStatus.
" - }, + "input":{"shape":"SetTaskStatusInput"}, + "output":{"shape":"SetTaskStatusOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"TaskNotFoundException", - "exception":true, - "documentation":"The specified task was not found.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"TaskNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.
Contains the parameters for ValidatePipelineDefinition.
" - }, - "output":{ - "shape":"ValidatePipelineDefinitionOutput", - "documentation":"Contains the output of ValidatePipelineDefinition.
" - }, + "input":{"shape":"ValidatePipelineDefinitionInput"}, + "output":{"shape":"ValidatePipelineDefinitionOutput"}, "errors":[ - { - "shape":"InternalServiceError", - "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" - }, - { - "shape":"InvalidRequestException", - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" - }, - { - "shape":"PipelineNotFoundException", - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" - }, - { - "shape":"PipelineDeletedException", - "exception":true, - "documentation":"The specified pipeline has been deleted.
" - } + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineDeletedException"} ], "documentation":"Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
" } @@ -1016,9 +604,9 @@ "documentation":"Description of the error message.
" } }, + "documentation":"An internal service error occurred.
", "exception":true, - "fault":true, - "documentation":"An internal service error occurred.
" + "fault":true }, "InvalidRequestException":{ "type":"structure", @@ -1028,8 +616,8 @@ "documentation":"Description of the error message.
" } }, - "exception":true, - "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
" + "documentation":"The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
", + "exception":true }, "ListPipelinesInput":{ "type":"structure", @@ -1158,8 +746,8 @@ "documentation":"Description of the error message.
" } }, - "exception":true, - "documentation":"The specified pipeline has been deleted.
" + "documentation":"The specified pipeline has been deleted.
", + "exception":true }, "PipelineDescription":{ "type":"structure", @@ -1218,8 +806,8 @@ "documentation":"Description of the error message.
" } }, - "exception":true, - "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
" + "documentation":"The specified pipeline was not found. Verify that you used the correct user and account identifiers.
", + "exception":true }, "PipelineObject":{ "type":"structure", @@ -1566,8 +1154,8 @@ "documentation":"Description of the error message.
" } }, - "exception":true, - "documentation":"The specified task was not found.
" + "documentation":"The specified task was not found.
", + "exception":true }, "TaskObject":{ "type":"structure", @@ -1682,14 +1270,14 @@ }, "attributeNameString":{ "type":"string", - "min":1, "max":256, + "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "attributeValueString":{ "type":"string", - "min":0, "max":10240, + "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "boolean":{"type":"boolean"}, @@ -1701,20 +1289,20 @@ }, "fieldNameString":{ "type":"string", - "min":1, "max":256, + "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "fieldStringValue":{ "type":"string", - "min":0, "max":10240, + "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "id":{ "type":"string", - "min":1, "max":1024, + "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "idList":{ @@ -1724,8 +1312,8 @@ "int":{"type":"integer"}, "longString":{ "type":"string", - "min":0, "max":20971520, + "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "pipelineList":{ @@ -1734,8 +1322,8 @@ }, "string":{ "type":"string", - "min":0, "max":1024, + "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "stringList":{ @@ -1744,36 +1332,37 @@ }, "tagKey":{ "type":"string", - "min":1, - "max":128 + "max":128, + "min":1 }, "tagList":{ "type":"list", "member":{"shape":"Tag"}, - "min":0, - "max":10 + "max":10, + "min":0 }, "tagValue":{ "type":"string", - "min":0, - "max":256 + "max":256, + "min":0 }, "taskId":{ "type":"string", - "min":1, "max":2048, + "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "timestamp":{"type":"timestamp"}, "validationMessage":{ "type":"string", - "min":0, "max":10000, + "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "validationMessages":{ "type":"list", "member":{"shape":"validationMessage"} } - } + }, + "documentation":"AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.
AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.
AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.
" } From be3e94e68742b391186082e51ef89b72b6563d75 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:02 +0000 Subject: [PATCH 05/19] Amazon CloudHSM Update: Minor documentation and link updates. --- .../feature-AmazonCloudHSM-5749bc7.json | 6 ++ .../codegen-resources/service-2.json | 98 ++++++++----------- 2 files changed, 45 insertions(+), 59 deletions(-) create mode 100644 .changes/next-release/feature-AmazonCloudHSM-5749bc7.json diff --git a/.changes/next-release/feature-AmazonCloudHSM-5749bc7.json b/.changes/next-release/feature-AmazonCloudHSM-5749bc7.json new file mode 100644 index 000000000000..5e1613cd5c58 --- /dev/null +++ b/.changes/next-release/feature-AmazonCloudHSM-5749bc7.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon CloudHSM", + "contributor": "", + "description": "Minor documentation and link updates." +} diff --git a/services/cloudhsm/src/main/resources/codegen-resources/service-2.json b/services/cloudhsm/src/main/resources/codegen-resources/service-2.json index 139daddb6746..dc6f74aa78b1 100644 --- a/services/cloudhsm/src/main/resources/codegen-resources/service-2.json +++ b/services/cloudhsm/src/main/resources/codegen-resources/service-2.json @@ -26,7 +26,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Adds or overwrites one or more tags for the specified AWS CloudHSM resource.
Each tag consists of a key and a value. Tag keys must be unique to each resource.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Adds or overwrites one or more tags for the specified AWS CloudHSM resource.
Each tag consists of a key and a value. Tag keys must be unique to each resource.
" }, "CreateHapg":{ "name":"CreateHapg", @@ -41,7 +41,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
" }, "CreateHsm":{ "name":"CreateHsm", @@ -56,7 +56,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an uninitialized HSM instance.
There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.
It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an uninitialized HSM instance.
There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.
It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an HSM client.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an HSM client.
" }, "DeleteHapg":{ "name":"DeleteHapg", @@ -86,7 +86,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a high-availability partition group.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a high-availability partition group.
" }, "DeleteHsm":{ "name":"DeleteHsm", @@ -101,7 +101,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
" }, "DeleteLunaClient":{ "name":"DeleteLunaClient", @@ -116,7 +116,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a client.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a client.
" }, "DescribeHapg":{ "name":"DescribeHapg", @@ -131,7 +131,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about a high-availability partition group.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about a high-availability partition group.
" }, "DescribeHsm":{ "name":"DescribeHsm", @@ -146,7 +146,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
" }, "DescribeLunaClient":{ "name":"DescribeLunaClient", @@ -161,7 +161,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM client.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM client.
" }, "GetConfig":{ "name":"GetConfig", @@ -176,7 +176,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
" }, "ListAvailableZones":{ "name":"ListAvailableZones", @@ -191,7 +191,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists the Availability Zones that have available AWS CloudHSM capacity.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists the Availability Zones that have available AWS CloudHSM capacity.
" }, "ListHapgs":{ "name":"ListHapgs", @@ -206,7 +206,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists the high-availability partition groups for the account.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists the high-availability partition groups for the account.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves the identifiers of all of the HSMs provisioned for the current customer.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves the identifiers of all of the HSMs provisioned for the current customer.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists all of the clients.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists all of the clients.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Returns a list of all tags for the specified AWS CloudHSM resource.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Returns a list of all tags for the specified AWS CloudHSM resource.
" }, "ModifyHapg":{ "name":"ModifyHapg", @@ -266,7 +266,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies an existing high-availability partition group.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies an existing high-availability partition group.
" }, "ModifyHsm":{ "name":"ModifyHsm", @@ -281,7 +281,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies an HSM.
This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies an HSM.
This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.
" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", @@ -309,7 +309,7 @@ {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Removes one or more tags from the specified AWS CloudHSM resource.
To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Removes one or more tags from the specified AWS CloudHSM resource.
To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
" } }, "shapes":{ @@ -445,46 +445,35 @@ "members":{ "SubnetId":{ "shape":"SubnetId", - "documentation":"The identifier of the subnet in your VPC in which to place the HSM.
", - "locationName":"SubnetId" + "documentation":"The identifier of the subnet in your VPC in which to place the HSM.
" }, "SshKey":{ "shape":"SshKey", - "documentation":"The SSH public key to install on the HSM.
", - "locationName":"SshKey" + "documentation":"The SSH public key to install on the HSM.
" }, "EniIp":{ "shape":"IpAddress", - "documentation":"The IP address to assign to the HSM's ENI.
If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
", - "locationName":"EniIp" + "documentation":"The IP address to assign to the HSM's ENI.
If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
" }, "IamRoleArn":{ "shape":"IamRoleArn", - "documentation":"The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
", - "locationName":"IamRoleArn" + "documentation":"The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
" }, "ExternalId":{ "shape":"ExternalId", - "documentation":"The external ID from IamRoleArn, if present.
The external ID from IamRoleArn, if present.
A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
", - "locationName":"ClientToken" + "documentation":"A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
" }, "SyslogIp":{ "shape":"IpAddress", - "documentation":"The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
", - "locationName":"SyslogIp" + "documentation":"The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
" } }, - "documentation":"Contains the inputs for the CreateHsm operation.
Contains the inputs for the CreateHsm operation.
The ARN of the HSM to delete.
", - "locationName":"HsmArn" + "documentation":"The ARN of the HSM to delete.
" } }, - "documentation":"Contains the inputs for the DeleteHsm operation.
", - "locationName":"DeleteHsmRequest" + "documentation":"Contains the inputs for the DeleteHsm operation.
" }, "DeleteHsmResponse":{ "type":"structure", @@ -1016,37 +1003,30 @@ "members":{ "HsmArn":{ "shape":"HsmArn", - "documentation":"The ARN of the HSM to modify.
", - "locationName":"HsmArn" + "documentation":"The ARN of the HSM to modify.
" }, "SubnetId":{ "shape":"SubnetId", - "documentation":"The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.
", - "locationName":"SubnetId" + "documentation":"The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.
" }, "EniIp":{ "shape":"IpAddress", - "documentation":"The new IP address for the elastic network interface (ENI) attached to the HSM.
If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.
", - "locationName":"EniIp" + "documentation":"The new IP address for the elastic network interface (ENI) attached to the HSM.
If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.
" }, "IamRoleArn":{ "shape":"IamRoleArn", - "documentation":"The new IAM role ARN.
", - "locationName":"IamRoleArn" + "documentation":"The new IAM role ARN.
" }, "ExternalId":{ "shape":"ExternalId", - "documentation":"The new external ID.
", - "locationName":"ExternalId" + "documentation":"The new external ID.
" }, "SyslogIp":{ "shape":"IpAddress", - "documentation":"The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
", - "locationName":"SyslogIp" + "documentation":"The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
" } }, - "documentation":"Contains the inputs for the ModifyHsm operation.
", - "locationName":"ModifyHsmRequest" + "documentation":"Contains the inputs for the ModifyHsm operation.
" }, "ModifyHsmResponse":{ "type":"structure", @@ -1193,5 +1173,5 @@ "pattern":"vpc-[0-9a-f]{8}" } }, - "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
" + "documentation":"This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
" } From ec402cc9237330431248902d66957817ebc8cc71 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:10 +0000 Subject: [PATCH 06/19] Amazon WorkMail Update: This release adds support for mobile device access rules management in Amazon WorkMail. --- .../feature-AmazonWorkMail-767e9b2.json | 6 + .../codegen-resources/service-2.json | 458 ++++++++++++++++++ 2 files changed, 464 insertions(+) create mode 100644 .changes/next-release/feature-AmazonWorkMail-767e9b2.json diff --git a/.changes/next-release/feature-AmazonWorkMail-767e9b2.json b/.changes/next-release/feature-AmazonWorkMail-767e9b2.json new file mode 100644 index 000000000000..f8de4f5c196f --- /dev/null +++ b/.changes/next-release/feature-AmazonWorkMail-767e9b2.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon WorkMail", + "contributor": "", + "description": "This release adds support for mobile device access rules management in Amazon WorkMail." +} diff --git a/services/workmail/src/main/resources/codegen-resources/service-2.json b/services/workmail/src/main/resources/codegen-resources/service-2.json index 2b2ce0337e0a..a31989aa31ed 100644 --- a/services/workmail/src/main/resources/codegen-resources/service-2.json +++ b/services/workmail/src/main/resources/codegen-resources/service-2.json @@ -111,6 +111,22 @@ "documentation":"Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
", "idempotent":true }, + "CreateMobileDeviceAccessRule":{ + "name":"CreateMobileDeviceAccessRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMobileDeviceAccessRuleRequest"}, + "output":{"shape":"CreateMobileDeviceAccessRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Creates a new mobile device access rule for the specified Amazon WorkMail organization.
" + }, "CreateOrganization":{ "name":"CreateOrganization", "http":{ @@ -241,6 +257,21 @@ "documentation":"Deletes permissions granted to a member (user or group).
", "idempotent":true }, + "DeleteMobileDeviceAccessRule":{ + "name":"DeleteMobileDeviceAccessRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMobileDeviceAccessRuleRequest"}, + "output":{"shape":"DeleteMobileDeviceAccessRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Deletes a mobile device access rule for the specified Amazon WorkMail organization.
" + }, "DeleteOrganization":{ "name":"DeleteOrganization", "http":{ @@ -499,6 +530,21 @@ "documentation":"Requests a user's mailbox details for a specified organization and user.
", "idempotent":true }, + "GetMobileDeviceAccessEffect":{ + "name":"GetMobileDeviceAccessEffect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMobileDeviceAccessEffectRequest"}, + "output":{"shape":"GetMobileDeviceAccessEffectResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Simulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the Amazon WorkMail organization for a particular user's attributes.
" + }, "ListAccessControlRules":{ "name":"ListAccessControlRules", "http":{ @@ -599,6 +645,21 @@ "documentation":"Lists the mailbox permissions associated with a user, group, or resource mailbox.
", "idempotent":true }, + "ListMobileDeviceAccessRules":{ + "name":"ListMobileDeviceAccessRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMobileDeviceAccessRulesRequest"}, + "output":{"shape":"ListMobileDeviceAccessRulesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Lists the mobile device access rules for the specified Amazon WorkMail organization.
" + }, "ListOrganizations":{ "name":"ListOrganizations", "http":{ @@ -838,6 +899,22 @@ "documentation":"Updates a user's current mailbox quota for a specified organization and user.
", "idempotent":true }, + "UpdateMobileDeviceAccessRule":{ + "name":"UpdateMobileDeviceAccessRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMobileDeviceAccessRuleRequest"}, + "output":{"shape":"UpdateMobileDeviceAccessRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"Updates a mobile device access rule for the specified Amazon WorkMail organization.
" + }, "UpdatePrimaryEmailAddress":{ "name":"UpdatePrimaryEmailAddress", "http":{ @@ -1144,6 +1221,78 @@ } } }, + "CreateMobileDeviceAccessRuleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "Effect" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The Amazon WorkMail organization under which the rule will be created.
" + }, + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"The idempotency token for the client request.
", + "idempotencyToken":true + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"The rule name.
" + }, + "Description":{ + "shape":"MobileDeviceAccessRuleDescription", + "documentation":"The rule description.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the rule when it matches. Allowed values are ALLOW or DENY.
Device types that the rule will match.
" + }, + "NotDeviceTypes":{ + "shape":"DeviceTypeList", + "documentation":"Device types that the rule will not match. All other device types will match.
" + }, + "DeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the rule will match.
" + }, + "NotDeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the rule will not match. All other device models will match.
" + }, + "DeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the rule will match.
" + }, + "NotDeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the rule will not match. All other device operating systems will match.
" + }, + "DeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that the rule will match.
" + }, + "NotDeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that the rule will not match. All other device user agents will match.
" + } + } + }, + "CreateMobileDeviceAccessRuleResponse":{ + "type":"structure", + "members":{ + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The identifier for the newly created mobile device access rule.
" + } + } + }, "CreateOrganizationRequest":{ "type":"structure", "required":["Alias"], @@ -1367,6 +1516,28 @@ "members":{ } }, + "DeleteMobileDeviceAccessRuleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "MobileDeviceAccessRuleId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The Amazon WorkMail organization under which the rule will be deleted.
" + }, + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The identifier of the rule to be deleted.
" + } + } + }, + "DeleteMobileDeviceAccessRuleResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteOrganizationRequest":{ "type":"structure", "required":[ @@ -1771,6 +1942,54 @@ "min":0, "pattern":"[\\S\\s]*" }, + "DeviceModel":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceModelList":{ + "type":"list", + "member":{"shape":"DeviceModel"}, + "max":10, + "min":1 + }, + "DeviceOperatingSystem":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceOperatingSystemList":{ + "type":"list", + "member":{"shape":"DeviceOperatingSystem"}, + "max":10, + "min":1 + }, + "DeviceType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceTypeList":{ + "type":"list", + "member":{"shape":"DeviceType"}, + "max":10, + "min":1 + }, + "DeviceUserAgent":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "DeviceUserAgentList":{ + "type":"list", + "member":{"shape":"DeviceUserAgent"}, + "max":10, + "min":1 + }, "DirectoryId":{ "type":"string", "max":12, @@ -2064,6 +2283,45 @@ } } }, + "GetMobileDeviceAccessEffectRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The Amazon WorkMail organization to simulate the access effect for.
" + }, + "DeviceType":{ + "shape":"DeviceType", + "documentation":"Device type the simulated user will report.
" + }, + "DeviceModel":{ + "shape":"DeviceModel", + "documentation":"Device model the simulated user will report.
" + }, + "DeviceOperatingSystem":{ + "shape":"DeviceOperatingSystem", + "documentation":"Device operating system the simulated user will report.
" + }, + "DeviceUserAgent":{ + "shape":"DeviceUserAgent", + "documentation":"Device user agent the simulated user will report.
" + } + } + }, + "GetMobileDeviceAccessEffectResponse":{ + "type":"structure", + "members":{ + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the Amazon WorkMail organization for the simulated user parameters.
A list of the rules which matched the simulated user input and produced the effect.
" + } + } + }, "Group":{ "type":"structure", "members":{ @@ -2371,6 +2629,25 @@ } } }, + "ListMobileDeviceAccessRulesRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The Amazon WorkMail organization for which to list the rules.
" + } + } + }, + "ListMobileDeviceAccessRulesResponse":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"MobileDeviceAccessRulesList", + "documentation":"The list of mobile device access rules that exist under the specified Amazon WorkMail organization.
" + } + } + }, "ListOrganizationsRequest":{ "type":"structure", "members":{ @@ -2651,6 +2928,119 @@ "type":"list", "member":{"shape":"Member"} }, + "MobileDeviceAccessMatchedRule":{ + "type":"structure", + "members":{ + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"Identifier of the rule that a simulated user matches.
" + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"Name of a rule that a simulated user matches.
" + } + }, + "documentation":"The rule that a simulated user matches.
" + }, + "MobileDeviceAccessMatchedRuleList":{ + "type":"list", + "member":{"shape":"MobileDeviceAccessMatchedRule"}, + "max":10, + "min":0 + }, + "MobileDeviceAccessRule":{ + "type":"structure", + "members":{ + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The ID assigned to a mobile access rule.
" + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"The name of a mobile access rule.
" + }, + "Description":{ + "shape":"MobileDeviceAccessRuleDescription", + "documentation":"The description of a mobile access rule.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the rule when it matches. Allowed values are ALLOW or DENY.
Device types that a rule will match.
" + }, + "NotDeviceTypes":{ + "shape":"DeviceTypeList", + "documentation":"Device types that a rule will not match. All other device types will match.
" + }, + "DeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that a rule will match.
" + }, + "NotDeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that a rule will not match. All other device models will match.
" + }, + "DeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that a rule will match.
" + }, + "NotDeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that a rule will not match. All other device types will match.
" + }, + "DeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that a rule will match.
" + }, + "NotDeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"Device user agents that a rule will not match. All other device user agents will match.
" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"The date and time at which an access rule was created.
" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"The date and time at which an access rule was modified.
" + } + }, + "documentation":"A rule that controls access to mobile devices for an Amazon WorkMail group.
" + }, + "MobileDeviceAccessRuleDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\S\\s]+" + }, + "MobileDeviceAccessRuleEffect":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "MobileDeviceAccessRuleId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "MobileDeviceAccessRuleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\S\\s]+" + }, + "MobileDeviceAccessRulesList":{ + "type":"list", + "member":{"shape":"MobileDeviceAccessRule"}, + "max":10, + "min":0 + }, "NameAvailabilityException":{ "type":"structure", "members":{ @@ -3258,6 +3648,74 @@ "members":{ } }, + "UpdateMobileDeviceAccessRuleRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "MobileDeviceAccessRuleId", + "Name", + "Effect" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"The Amazon WorkMail organization under which the rule will be updated.
" + }, + "MobileDeviceAccessRuleId":{ + "shape":"MobileDeviceAccessRuleId", + "documentation":"The identifier of the rule to be updated.
" + }, + "Name":{ + "shape":"MobileDeviceAccessRuleName", + "documentation":"The updated rule name.
" + }, + "Description":{ + "shape":"MobileDeviceAccessRuleDescription", + "documentation":"The updated rule description.
" + }, + "Effect":{ + "shape":"MobileDeviceAccessRuleEffect", + "documentation":"The effect of the rule when it matches. Allowed values are ALLOW or DENY.
Device types that the updated rule will match.
" + }, + "NotDeviceTypes":{ + "shape":"DeviceTypeList", + "documentation":"Device types that the updated rule will not match. All other device types will match.
" + }, + "DeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the updated rule will match.
" + }, + "NotDeviceModels":{ + "shape":"DeviceModelList", + "documentation":"Device models that the updated rule will not match. All other device models will match.
" + }, + "DeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the updated rule will match.
" + }, + "NotDeviceOperatingSystems":{ + "shape":"DeviceOperatingSystemList", + "documentation":"Device operating systems that the updated rule will not match. All other device operating systems will match.
" + }, + "DeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"User agents that the updated rule will match.
" + }, + "NotDeviceUserAgents":{ + "shape":"DeviceUserAgentList", + "documentation":"User agents that the updated rule will not match. All other user agents will match.
" + } + } + }, + "UpdateMobileDeviceAccessRuleResponse":{ + "type":"structure", + "members":{ + } + }, "UpdatePrimaryEmailAddressRequest":{ "type":"structure", "required":[ From f420493e135bf44ca35e0a64bc70c3799413d227 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:05 +0000 Subject: [PATCH 07/19] AWS Price List Service Update: Minor documentation and link updates. --- .../next-release/feature-AWSPriceListService-d9d8643.json | 6 ++++++ .../src/main/resources/codegen-resources/service-2.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 .changes/next-release/feature-AWSPriceListService-d9d8643.json diff --git a/.changes/next-release/feature-AWSPriceListService-d9d8643.json b/.changes/next-release/feature-AWSPriceListService-d9d8643.json new file mode 100644 index 000000000000..7940782f5ac1 --- /dev/null +++ b/.changes/next-release/feature-AWSPriceListService-d9d8643.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Price List Service", + "contributor": "", + "description": "Minor documentation and link updates." +} diff --git a/services/pricing/src/main/resources/codegen-resources/service-2.json b/services/pricing/src/main/resources/codegen-resources/service-2.json index bc77bc673e10..42a82e015f4d 100644 --- a/services/pricing/src/main/resources/codegen-resources/service-2.json +++ b/services/pricing/src/main/resources/codegen-resources/service-2.json @@ -46,7 +46,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"ExpiredNextTokenException"} ], - "documentation":"Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the AWS Billing and Cost Management User Guide.
" + "documentation":"Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the AWS Billing and Cost Management User Guide.
" }, "GetProducts":{ "name":"GetProducts", From 239bf9824b17781c2702934e4a70c8f5524283a5 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:12 +0000 Subject: [PATCH 08/19] Amazon Detective Update: Added the ability to assign tag values to Detective behavior graphs. Tag values can be used for attribute-based access control, and for cost allocation for billing. --- .../feature-AmazonDetective-283b026.json | 6 + .../codegen-resources/service-2.json | 152 ++++++++++++++++++ 2 files changed, 158 insertions(+) create mode 100644 .changes/next-release/feature-AmazonDetective-283b026.json diff --git a/.changes/next-release/feature-AmazonDetective-283b026.json b/.changes/next-release/feature-AmazonDetective-283b026.json new file mode 100644 index 000000000000..f1c98fa51c32 --- /dev/null +++ b/.changes/next-release/feature-AmazonDetective-283b026.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Detective", + "contributor": "", + "description": "Added the ability to assign tag values to Detective behavior graphs. Tag values can be used for attribute-based access control, and for cost allocation for billing." +} diff --git a/services/detective/src/main/resources/codegen-resources/service-2.json b/services/detective/src/main/resources/codegen-resources/service-2.json index a69195774999..2a278e7140ff 100644 --- a/services/detective/src/main/resources/codegen-resources/service-2.json +++ b/services/detective/src/main/resources/codegen-resources/service-2.json @@ -33,6 +33,7 @@ "method":"POST", "requestUri":"/graph" }, + "input":{"shape":"CreateGraphRequest"}, "output":{"shape":"CreateGraphResponse"}, "errors":[ {"shape":"ConflictException"}, @@ -160,6 +161,22 @@ ], "documentation":"Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
" }, + "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":"Returns the tag values that are assigned to a behavior graph.
" + }, "RejectInvitation":{ "name":"RejectInvitation", "http":{ @@ -190,6 +207,38 @@ {"shape":"ValidationException"} ], "documentation":"Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.
For valid member accounts, the status is updated as follows.
If Detective enabled the member account, then the new status is ENABLED.
If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.
Applies tag values to a behavior graph.
" + }, + "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 behavior graph.
" } }, "shapes":{ @@ -249,6 +298,15 @@ "error":{"httpStatusCode":409}, "exception":true }, + "CreateGraphRequest":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"The tags to assign to the new behavior graph. For each tag, you provide the tag key and the tag value.
" + } + } + }, "CreateGraphResponse":{ "type":"structure", "members":{ @@ -502,6 +560,27 @@ } } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"GraphArn", + "documentation":"The ARN of the behavior graph for which to retrieve the tag values.
", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"The tag values that are assigned to the behavior graph.
" + } + } + }, "MemberDetail":{ "type":"structure", "members":{ @@ -632,6 +711,53 @@ } } }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "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":"GraphArn", + "documentation":"The ARN of the behavior graph to assign the tags to.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"The tag values to assign to the behavior graph.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, "Timestamp":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -655,6 +781,32 @@ "member":{"shape":"UnprocessedAccount"} }, "UnprocessedReason":{"type":"string"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"GraphArn", + "documentation":"The ARN of the behavior graph to remove the tags from.
", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"The tag keys of the tags to remove from the behavior graph.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "ValidationException":{ "type":"structure", "members":{ From 3da1327cb3e230dbfdb8d69dced85c96b79c0f0a Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:15 +0000 Subject: [PATCH 09/19] AWS IoT Wireless Update: Add Sidewalk support to APIs: GetWirelessDevice, ListWirelessDevices, GetWirelessDeviceStatistics. Add Gateway connection status in GetWirelessGatewayStatistics API. --- .../feature-AWSIoTWireless-bdb5648.json | 6 + .../codegen-resources/service-2.json | 147 ++++++++++++++++++ 2 files changed, 153 insertions(+) create mode 100644 .changes/next-release/feature-AWSIoTWireless-bdb5648.json diff --git a/.changes/next-release/feature-AWSIoTWireless-bdb5648.json b/.changes/next-release/feature-AWSIoTWireless-bdb5648.json new file mode 100644 index 000000000000..e9772b96d907 --- /dev/null +++ b/.changes/next-release/feature-AWSIoTWireless-bdb5648.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS IoT Wireless", + "contributor": "", + "description": "Add Sidewalk support to APIs: GetWirelessDevice, ListWirelessDevices, GetWirelessDeviceStatistics. Add Gateway connection status in GetWirelessGatewayStatistics API." +} diff --git a/services/iotwireless/src/main/resources/codegen-resources/service-2.json b/services/iotwireless/src/main/resources/codegen-resources/service-2.json index ea0b373c6113..a5b2fe205339 100644 --- a/services/iotwireless/src/main/resources/codegen-resources/service-2.json +++ b/services/iotwireless/src/main/resources/codegen-resources/service-2.json @@ -1087,12 +1087,45 @@ } }, "AutoCreateTasks":{"type":"boolean"}, + "BatteryLevel":{ + "type":"string", + "documentation":"Sidewalk device battery level.
", + "enum":[ + "normal", + "low", + "critical" + ] + }, + "CertificateList":{ + "type":"structure", + "required":[ + "SigningAlg", + "Value" + ], + "members":{ + "SigningAlg":{ + "shape":"SigningAlg", + "documentation":"The certificate chain algorithm provided by sidewalk.
" + }, + "Value":{ + "shape":"CertificateValue", + "documentation":"The value of the chosen sidewalk certificate.
" + } + }, + "documentation":"List of sidewalk certificates.
" + }, "CertificatePEM":{ "type":"string", "max":4096, "min":1, "pattern":"[^-A-Za-z0-9+/=]|=[^=]|={3,}${1,4096}" }, + "CertificateValue":{ + "type":"string", + "documentation":"Certificate value.
", + "max":2048, + "min":0 + }, "ChannelMask":{ "type":"string", "max":2048 @@ -1124,6 +1157,13 @@ "error":{"httpStatusCode":409}, "exception":true }, + "ConnectionStatus":{ + "type":"string", + "enum":[ + "Connected", + "Disconnected" + ] + }, "Crc":{ "type":"long", "max":4294967295, @@ -1591,6 +1631,11 @@ "max":2147483647, "min":0 }, + "DeviceCertificateList":{ + "type":"list", + "member":{"shape":"CertificateList"}, + "documentation":"List of device certificate chain.
" + }, "DeviceProfile":{ "type":"structure", "members":{ @@ -1622,6 +1667,16 @@ "type":"string", "max":256 }, + "DeviceState":{ + "type":"string", + "documentation":"Device state defines the device status of sidewalk device.
", + "enum":[ + "Provisioned", + "RegisteredNotSeen", + "RegisteredReachable", + "RegisteredUnreachable" + ] + }, "DisassociateAwsAccountFromPartnerAccountRequest":{ "type":"structure", "required":[ @@ -1729,6 +1784,17 @@ "max":256, "min":1 }, + "Event":{ + "type":"string", + "documentation":"Sidewalk device status notification.
", + "enum":[ + "discovered", + "lost", + "ack", + "nack", + "passthrough" + ] + }, "Expression":{ "type":"string", "max":2048 @@ -1994,6 +2060,10 @@ "LoRaWAN":{ "shape":"LoRaWANDevice", "documentation":"Information about the wireless device.
" + }, + "Sidewalk":{ + "shape":"SidewalkDevice", + "documentation":"Sidewalk device object.
" } } }, @@ -2023,6 +2093,10 @@ "LoRaWAN":{ "shape":"LoRaWANDeviceMetadata", "documentation":"Information about the wireless device's operations.
" + }, + "Sidewalk":{ + "shape":"SidewalkDeviceMetadata", + "documentation":"MetaData for Sidewalk device.
" } } }, @@ -2148,6 +2222,10 @@ "LastUplinkReceivedAt":{ "shape":"ISODateTimeString", "documentation":"The date and time when the most recent uplink was received.
" + }, + "ConnectionStatus":{ + "shape":"ConnectionStatus", + "documentation":"The connection status of the wireless gateway.
" } } }, @@ -3207,16 +3285,77 @@ "type":"list", "member":{"shape":"SidewalkAccountInfoWithFingerprint"} }, + "SidewalkDevice":{ + "type":"structure", + "members":{ + "SidewalkId":{ + "shape":"SidewalkId", + "documentation":"The sidewalk device identification.
" + }, + "SidewalkManufacturingSn":{ + "shape":"SidewalkManufacturingSn", + "documentation":"The Sidewalk manufacturing series number.
" + }, + "DeviceCertificates":{ + "shape":"DeviceCertificateList", + "documentation":"The sidewalk device certificates for Ed25519 and P256r1.
" + } + }, + "documentation":"Sidewalk device object.
" + }, + "SidewalkDeviceMetadata":{ + "type":"structure", + "members":{ + "Rssi":{ + "shape":"Integer", + "documentation":"The RSSI value.
" + }, + "BatteryLevel":{ + "shape":"BatteryLevel", + "documentation":"Sidewalk device battery level.
" + }, + "Event":{ + "shape":"Event", + "documentation":"Sidewalk device status notification.
" + }, + "DeviceState":{ + "shape":"DeviceState", + "documentation":"Device state defines the device status of sidewalk device.
" + } + }, + "documentation":"MetaData for Sidewalk device.
" + }, + "SidewalkId":{ + "type":"string", + "documentation":"The sidewalk device identification.
", + "max":256 + }, "SidewalkListDevice":{ "type":"structure", "members":{ "AmazonId":{ "shape":"AmazonId", "documentation":"The Sidewalk Amazon ID.
" + }, + "SidewalkId":{ + "shape":"SidewalkId", + "documentation":"The sidewalk device identification.
" + }, + "SidewalkManufacturingSn":{ + "shape":"SidewalkManufacturingSn", + "documentation":"The Sidewalk manufacturing series number.
" + }, + "DeviceCertificates":{ + "shape":"DeviceCertificateList", + "documentation":"The sidewalk device certificates for Ed25519 and P256r1.
" } }, "documentation":"Sidewalk object used by list functions.
" }, + "SidewalkManufacturingSn":{ + "type":"string", + "max":64 + }, "SidewalkSendDataToDevice":{ "type":"structure", "members":{ @@ -3237,6 +3376,14 @@ }, "documentation":"Sidewalk update.
" }, + "SigningAlg":{ + "type":"string", + "documentation":"The certificate chain algorithm provided by sidewalk.
", + "enum":[ + "Ed25519", + "P256r1" + ] + }, "Station":{ "type":"string", "max":4096, From 0f9e36c759eb3e6872651464a35d2f9f847da225 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:08 +0000 Subject: [PATCH 10/19] AWS Cloud9 Update: Add ImageId input parameter to CreateEnvironmentEC2 endpoint. New parameter enables creation of environments with different AMIs. --- .../feature-AWSCloud9-6460db9.json | 6 ++ .../codegen-resources/service-2.json | 72 ++++++++++++++++--- 2 files changed, 67 insertions(+), 11 deletions(-) create mode 100644 .changes/next-release/feature-AWSCloud9-6460db9.json diff --git a/.changes/next-release/feature-AWSCloud9-6460db9.json b/.changes/next-release/feature-AWSCloud9-6460db9.json new file mode 100644 index 000000000000..7e2518c3a1d9 --- /dev/null +++ b/.changes/next-release/feature-AWSCloud9-6460db9.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Cloud9", + "contributor": "", + "description": "Add ImageId input parameter to CreateEnvironmentEC2 endpoint. New parameter enables creation of environments with different AMIs." +} diff --git a/services/cloud9/src/main/resources/codegen-resources/service-2.json b/services/cloud9/src/main/resources/codegen-resources/service-2.json index 52d079e7cf23..12b196578bcc 100644 --- a/services/cloud9/src/main/resources/codegen-resources/service-2.json +++ b/services/cloud9/src/main/resources/codegen-resources/service-2.json @@ -327,6 +327,10 @@ "shape":"SubnetId", "documentation":"The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
" }, + "imageId":{ + "shape":"ImageId", + "documentation":"The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. You can specify the AMI for the instance using an AMI alias or an AWS Systems Manager (SSM) path. The default AMI is used if the parameter isn't explicitly assigned a value in the request.
AMI aliases
Amazon Linux 2: amazonlinux-2-x86_64
Ubuntu 18.04: ubuntu-18.04-x86_64
Amazon Linux (default): amazonlinux-1-x86_64
SSM paths
Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64
Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64
Amazon Linux (default): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64
The number of minutes until the running instance is shut down after the environment has last been used.
" @@ -341,7 +345,7 @@ }, "connectionType":{ "shape":"ConnectionType", - "documentation":"The connection type used for connecting to an Amazon EC2 environment.
" + "documentation":"The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through AWS Systems Manager).
For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS Cloud9 User Guide.
" } } }, @@ -378,6 +382,7 @@ }, "CreateEnvironmentMembershipResult":{ "type":"structure", + "required":["membership"], "members":{ "membership":{ "shape":"EnvironmentMember", @@ -472,6 +477,10 @@ }, "DescribeEnvironmentStatusResult":{ "type":"structure", + "required":[ + "status", + "message" + ], "members":{ "status":{ "shape":"EnvironmentStatus", @@ -504,6 +513,11 @@ }, "Environment":{ "type":"structure", + "required":[ + "type", + "arn", + "ownerArn" + ], "members":{ "id":{ "shape":"EnvironmentId", @@ -523,7 +537,7 @@ }, "connectionType":{ "shape":"ConnectionType", - "documentation":"The connection type used for connecting to an Amazon EC2 environment.
" + "documentation":"The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.
The state of the environment in its creation or deletion lifecycle.
" + }, + "managedCredentialsStatus":{ + "shape":"ManagedCredentialsStatus", + "documentation":"Describes the status of AWS managed temporary credentials for the AWS Cloud9 environment. Available values are:
ENABLED_ON_CREATE
ENABLED_BY_OWNER
DISABLED_BY_DEFAULT
DISABLED_BY_OWNER
DISABLED_BY_COLLABORATOR
PENDING_REMOVAL_BY_COLLABORATOR
PENDING_REMOVAL_BY_OWNER
FAILED_REMOVAL_BY_COLLABORATOR
ENABLED_BY_OWNER
DISABLED_BY_DEFAULT
Information about an AWS Cloud9 development environment.
" }, "EnvironmentArn":{ "type":"string", - "pattern":"arn:aws:cloud9:([a-z]{2}-[a-z]+-\\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}" + "pattern":"arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):cloud9:([a-z]{2}-[a-z]+-\\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}" }, "EnvironmentDescription":{ "type":"string", @@ -591,6 +609,12 @@ }, "EnvironmentMember":{ "type":"structure", + "required":[ + "permissions", + "userId", + "userArn", + "environmentId" + ], "members":{ "permissions":{ "shape":"Permissions", @@ -650,6 +674,10 @@ "documentation":"An access permissions issue occurred.
", "exception":true }, + "ImageId":{ + "type":"string", + "max":512 + }, "InstanceType":{ "type":"string", "max":20, @@ -716,6 +744,22 @@ } } }, + "ManagedCredentialsStatus":{ + "type":"string", + "enum":[ + "ENABLED_ON_CREATE", + "ENABLED_BY_OWNER", + "DISABLED_BY_DEFAULT", + "DISABLED_BY_OWNER", + "DISABLED_BY_COLLABORATOR", + "PENDING_REMOVAL_BY_COLLABORATOR", + "PENDING_START_REMOVAL_BY_COLLABORATOR", + "PENDING_REMOVAL_BY_OWNER", + "PENDING_START_REMOVAL_BY_OWNER", + "FAILED_REMOVAL_BY_COLLABORATOR", + "FAILED_REMOVAL_BY_OWNER" + ] + }, "MaxResults":{ "type":"integer", "box":true, @@ -751,8 +795,9 @@ "String":{"type":"string"}, "SubnetId":{ "type":"string", - "max":30, - "min":5 + "max":24, + "min":15, + "pattern":"^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$" }, "Tag":{ "type":"structure", @@ -770,24 +815,28 @@ "documentation":"The value part of a tag.
" } }, - "documentation":"Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.
" + "documentation":"Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.
", + "sensitive":true }, "TagKey":{ "type":"string", "max":128, - "min":1 + "min":1, + "sensitive":true }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, - "min":0 + "min":0, + "sensitive":true }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":200, - "min":0 + "min":0, + "sensitive":true }, "TagResourceRequest":{ "type":"structure", @@ -814,7 +863,8 @@ "TagValue":{ "type":"string", "max":256, - "min":0 + "min":0, + "sensitive":true }, "Timestamp":{"type":"timestamp"}, "TooManyRequestsException":{ @@ -902,7 +952,7 @@ }, "UserArn":{ "type":"string", - "pattern":"^arn:aws:(iam|sts)::\\d+:(root|(user\\/[\\w+=/:,.@-]{1,64}|federated-user\\/[\\w+=/:,.@-]{2,32}|assumed-role\\/[\\w+=:,.@-]{1,64}\\/[\\w+=,.@-]{1,64}))$" + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(iam|sts)::\\d+:(root|(user\\/[\\w+=/:,.@-]{1,64}|federated-user\\/[\\w+=/:,.@-]{2,32}|assumed-role\\/[\\w+=:,.@-]{1,64}\\/[\\w+=,.@-]{1,64}))$" } }, "documentation":"AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.
For more information about AWS Cloud9, see the AWS Cloud9 User Guide.
AWS Cloud9 supports these operations:
CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
CreateEnvironmentMembership: Adds an environment member to an environment.
DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
DeleteEnvironmentMembership: Deletes an environment member from an environment.
DescribeEnvironmentMemberships: Gets information about environment members for an environment.
DescribeEnvironments: Gets information about environments.
DescribeEnvironmentStatus: Gets status information for an environment.
ListEnvironments: Gets a list of environment identifiers.
ListTagsForResource: Gets the tags for an environment.
TagResource: Adds tags to an environment.
UntagResource: Removes tags from an environment.
UpdateEnvironment: Changes the settings of an existing environment.
UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.
Amazon ML returns the following elements.
" - }, + "output":{"shape":"AddTagsOutput"}, "errors":[ - { - "shape":"InvalidInputException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InvalidTagException", - "exception":true - }, - { - "shape":"TagLimitExceededException", - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InvalidTagException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value.
Represents the output of a CreateBatchPrediction operation, and is an acknowledgement that Amazon ML received the request.
The CreateBatchPrediction operation is asynchronous. You can poll for status updates by using the >GetBatchPrediction operation and checking the Status parameter of the result.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - }, - { - "shape":"IdempotentParameterMismatchException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.
CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.
You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.
Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.
CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.
You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.
Represents the output of a CreateDataSourceFromRDS operation, and is an acknowledgement that Amazon ML received the request.
The CreateDataSourceFromRDS> operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter. You can inspect the Message when Status shows up as FAILED. You can also check the progress of the copy operation by going to the DataPipeline console and looking up the pipeline using the pipelineId from the describe call.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - }, - { - "shape":"IdempotentParameterMismatchException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations.
If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations.
If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
Represents the output of a CreateDataSourceFromRedshift operation, and is an acknowledgement that Amazon ML received the request.
The CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - }, - { - "shape":"IdempotentParameterMismatchException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.
After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.
You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.
Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.
After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.
You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.
Represents the output of a CreateDataSourceFromS3 operation, and is an acknowledgement that Amazon ML received the request.
The CreateDataSourceFromS3 operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - }, - { - "shape":"IdempotentParameterMismatchException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.
If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource.
After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.
Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.
CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.
If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.
The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource.
After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.
Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.
CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - }, - { - "shape":"IdempotentParameterMismatchException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS.
CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED.
You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.
Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS.
CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED.
You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.
Represents the output of a CreateMLModel operation, and is an acknowledgement that Amazon ML received the request.
The CreateMLModel operation is asynchronous. You can poll for status updates by using the GetMLModel operation and checking the Status parameter.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - }, - { - "shape":"IdempotentParameterMismatchException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Creates a new MLModel using the DataSource and the recipe as information sources.
An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel.
CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED.
You can use the GetMLModel operation to check the progress of the MLModel during the creation operation.
CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations.
Creates a new MLModel using the DataSource and the recipe as information sources.
An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel.
CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED.
You can use the GetMLModel operation to check the progress of the MLModel during the creation operation.
CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations.
Represents the output of an CreateRealtimeEndpoint operation.
The result contains the MLModelId and the endpoint information for the MLModel.
The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel.
Represents the output of a DeleteBatchPrediction operation.
You can use the GetBatchPrediction operation and check the value of the Status parameter to see whether a BatchPrediction is marked as DELETED.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], - "documentation":"Assigns the DELETED status to a BatchPrediction, rendering it unusable.
After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED.
Caution: The result of the DeleteBatchPrediction operation is irreversible.
Assigns the DELETED status to a BatchPrediction, rendering it unusable.
After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED.
Caution: The result of the DeleteBatchPrediction operation is irreversible.
Represents the output of a DeleteDataSource operation.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], - "documentation":"Assigns the DELETED status to a DataSource, rendering it unusable.
After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED.
Caution: The results of the DeleteDataSource operation are irreversible.
Assigns the DELETED status to a DataSource, rendering it unusable.
After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED.
Caution: The results of the DeleteDataSource operation are irreversible.
Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.
You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], - "documentation":"Assigns the DELETED status to an Evaluation, rendering it unusable.
After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.
The results of the DeleteEvaluation operation are irreversible.
Assigns the DELETED status to an Evaluation, rendering it unusable.
After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.
Caution: The results of the DeleteEvaluation operation are irreversible.
Represents the output of a DeleteMLModel operation.
You can use the GetMLModel operation and check the value of the Status parameter to see whether an MLModel is marked as DELETED.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], - "documentation":"Assigns the DELETED status to an MLModel, rendering it unusable.
After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED.
Caution: The result of the DeleteMLModel operation is irreversible.
Assigns the DELETED status to an MLModel, rendering it unusable.
After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED.
Caution: The result of the DeleteMLModel operation is irreversible.
Represents the output of an DeleteRealtimeEndpoint operation.
The result contains the MLModelId and the endpoint information for the MLModel.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Deletes a real time endpoint of an MLModel.
Amazon ML returns the following elements.
" - }, + "output":{"shape":"DeleteTagsOutput"}, "errors":[ - { - "shape":"InvalidInputException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InvalidTagException", - "exception":true - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InvalidTagException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.
If you specify a tag that doesn't exist, Amazon ML ignores it.
" }, @@ -508,24 +232,10 @@ "requestUri":"/" }, "input":{"shape":"DescribeBatchPredictionsInput"}, - "output":{ - "shape":"DescribeBatchPredictionsOutput", - "documentation":"Represents the output of a DescribeBatchPredictions operation. The content is essentially a list of BatchPredictions.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns a list of BatchPrediction operations that match the search criteria in the request.
Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns a list of DataSource that match the search criteria in the request.
Represents the query results from a DescribeEvaluations operation. The content is essentially a list of Evaluation.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns a list of DescribeEvaluations that match the search criteria in the request.
Represents the output of a DescribeMLModels operation. The content is essentially a list of MLModel.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns a list of MLModel that match the search criteria in the request.
Amazon ML returns the following elements.
" - }, + "output":{"shape":"DescribeTagsOutput"}, "errors":[ - { - "shape":"InvalidInputException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Describes one or more of the tags for your Amazon ML object.
" }, @@ -654,30 +303,11 @@ "requestUri":"/" }, "input":{"shape":"GetBatchPredictionInput"}, - "output":{ - "shape":"GetBatchPredictionOutput", - "documentation":"Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.
Represents the output of a GetDataSource operation and describes a DataSource.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], - "documentation":"Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.
GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.
Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.
GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.
Represents the output of a GetEvaluation operation and describes an Evaluation.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Returns an Evaluation that includes metadata as well as the current status of the Evaluation.
Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], - "documentation":"Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.
GetMLModel provides results in normal or verbose format.
Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.
GetMLModel provides results in normal or verbose format.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"LimitExceededException", - "error":{"httpStatusCode":417}, - "exception":true, - "documentation":"The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.
An error on the server occurred when trying to process a request.
" - }, - { - "shape":"PredictorNotMountedException", - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"The exception is thrown when a predict request is made to an unmounted MLModel.
Generates a prediction for the observation using the specified ML Model.
Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.
Generates a prediction for the observation using the specified ML Model.
Note: Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.
" }, "UpdateBatchPrediction":{ "name":"UpdateBatchPrediction", @@ -833,30 +380,11 @@ "requestUri":"/" }, "input":{"shape":"UpdateBatchPredictionInput"}, - "output":{ - "shape":"UpdateBatchPredictionOutput", - "documentation":"Represents the output of an UpdateBatchPrediction operation.
You can see the updated content by using the GetBatchPrediction operation.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Updates the BatchPredictionName of a BatchPrediction.
You can use the GetBatchPrediction operation to view the contents of the updated data element.
Represents the output of an UpdateDataSource operation.
You can see the updated content by using the GetBatchPrediction operation.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Updates the DataSourceName of a DataSource.
You can use the GetDataSource operation to view the contents of the updated data element.
Represents the output of an UpdateEvaluation operation.
You can see the updated content by using the GetEvaluation operation.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Updates the EvaluationName of an Evaluation.
You can use the GetEvaluation operation to view the contents of the updated data element.
Represents the output of an UpdateMLModel operation.
You can see the updated content by using the GetMLModel operation.
An error on the client occurred. Typically, the cause is an invalid input value.
" - }, - { - "shape":"ResourceNotFoundException", - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" - }, - { - "shape":"InternalServerException", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" - } + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} ], "documentation":"Updates the MLModelName and the ScoreThreshold of an MLModel.
You can use the GetMLModel operation to view the contents of the updated data element.
The type of the ML object to tag.
" + "documentation":"The type of the ML object to tag.
" } } }, @@ -998,17 +469,17 @@ "documentation":"The type of the ML object that was tagged.
" } }, - "documentation":"Amazon ML returns the following elements.
" + "documentation":"Amazon ML returns the following elements.
" }, "Algorithm":{ "type":"string", - "enum":["sgd"], - "documentation":"The function used to train an MLModel. Training choices supported by Amazon ML include the following:
SGD - Stochastic Gradient Descent.RandomForest - Random forest of decision trees.The function used to train an MLModel. Training choices supported by Amazon ML include the following:
SGD - Stochastic Gradient Descent.
RandomForest - Random forest of decision trees.
An Amazon Web Service (AWS) user account identifier. The account identifier can be an AWS root account or an AWS Identity and Access Management (IAM) user.
" + "documentation":"An Amazon Web Service (AWS) user account identifier. The account identifier can be an AWS root account or an AWS Identity and Access Management (IAM) user.
", + "pattern":"arn:aws:iam::[0-9]+:((user/.+)|(root))" }, "BatchPrediction":{ "type":"structure", @@ -1047,7 +518,7 @@ }, "Status":{ "shape":"EntityStatus", - "documentation":"The status of the BatchPrediction. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.INPROGRESS - The process is underway.FAILED - The request to perform a batch prediction did not run to completion. It is not usable.COMPLETED - The batch prediction process completed successfully.DELETED - The BatchPrediction is marked as deleted. It is not usable.The status of the BatchPrediction. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.
INPROGRESS - The process is underway.
FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
COMPLETED - The batch prediction process completed successfully.
DELETED - The BatchPrediction is marked as deleted. It is not usable.
A list of the variables to use in searching or filtering BatchPrediction.
CreatedAt - Sets the search criteria to BatchPrediction creation date.
Status - Sets the search criteria to BatchPrediction status.
Name - Sets the search criteria to the contents of BatchPrediction Name.
IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
A list of the variables to use in searching or filtering BatchPrediction.
CreatedAt - Sets the search criteria to BatchPrediction creation date.Status - Sets the search criteria to BatchPrediction status.Name - Sets the search criteria to the contents of BatchPrediction Name.IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.The value specified in a filtering condition. The ComparatorValue becomes the reference value when matching or evaluating data values in filtering and searching functions.
The value specified in a filtering condition. The ComparatorValue becomes the reference value when matching or evaluating data values in filtering and searching functions.
The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.
Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
" + "documentation":"The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.
Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
" } } }, @@ -1149,15 +620,15 @@ }, "RDSData":{ "shape":"RDSDataSpec", - "documentation":"The data specification of an Amazon RDS DataSource:
DatabaseInformation -
DatabaseName - The name of the Amazon RDS database.InstanceIdentifier - A unique identifier for the Amazon RDS database instance.DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.
ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.
ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.
SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.
S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
DataSchemaUri - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
The data specification of an Amazon RDS DataSource:
DatabaseInformation -
DatabaseName - The name of the Amazon RDS database.
InstanceIdentifier - A unique identifier for the Amazon RDS database instance.
DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.
ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.
ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.
SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.
S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
DataSchemaUri - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.
" + "documentation":"
The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.
The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
The data specification of an Amazon Redshift DataSource:
DatabaseInformation -
DatabaseName - The name of the Amazon Redshift database. ClusterIdentifier - The unique ID for the Amazon Redshift cluster.DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location.
DataSchemaUri - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the DataSource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
The data specification of an Amazon Redshift DataSource:
DatabaseInformation -
DatabaseName - The name of the Amazon Redshift database.
ClusterIdentifier - The unique ID for the Amazon Redshift cluster.
DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location.
DataSchemaUri - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the DataSource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:
A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster
An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation
A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:
A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster
An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation
The data specification of a DataSource:
DataLocationS3 - The Amazon S3 location of the observation data.
DataSchemaLocationS3 - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
The data specification of a DataSource:
DataLocationS3 - The Amazon S3 location of the observation data.
DataSchemaLocationS3 - The Amazon S3 location of the DataSchema.
DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.
Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"
The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
The user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.
Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.
CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.
Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.
CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.
The category of supervised learning that this MLModel will address. Choose from the following types:
REGRESSION if the MLModel will be used to predict a numeric value.BINARY if the MLModel result has two possible values.MULTICLASS if the MLModel result has a limited number of values. For more information, see the Amazon Machine Learning Developer Guide.
" + "documentation":"The category of supervised learning that this MLModel will address. Choose from the following types:
Choose REGRESSION if the MLModel will be used to predict a numeric value.
Choose BINARY if the MLModel result has two possible values.
Choose MULTICLASS if the MLModel result has a limited number of values.
For more information, see the Amazon Machine Learning Developer Guide.
" }, "Parameters":{ "shape":"TrainingParameters", - "documentation":"A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
The endpoint information of the MLModel
Represents the output of an CreateRealtimeEndpoint operation.
The result contains the MLModelId and the endpoint information for the MLModel.
The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.
Represents the output of an CreateRealtimeEndpoint operation.
The result contains the MLModelId and the endpoint information for the MLModel.
Note: The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.
The schema of a DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. The DataSource schema is expressed in JSON format.
DataSchema is not required if you specify a DataSchemaUri
{ \"version\": \"1.0\", \"recordAnnotationFieldName\": \"F1\", \"recordWeightFieldName\": \"F2\", \"targetFieldName\": \"F3\", \"dataFormat\": \"CSV\", \"dataFileContainsHeader\": true, \"variables\": [ { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ], \"excludedVariableNames\": [ \"F6\" ] }
" + "documentation":"The schema of a DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. The DataSource schema is expressed in JSON format.
DataSchema is not required if you specify a DataSchemaUri
{ \"version\": \"1.0\", \"recordAnnotationFieldName\": \"F1\", \"recordWeightFieldName\": \"F2\", \"targetFieldName\": \"F3\", \"dataFormat\": \"CSV\", \"dataFileContainsHeader\": true, \"variables\": [ { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ], \"excludedVariableNames\": [ \"F6\" ] }
", + "max":131071 }, "DataSource":{ "type":"structure", @@ -1401,7 +872,7 @@ }, "Status":{ "shape":"EntityStatus", - "documentation":"The current status of the DataSource. This element can have one of the following values:
DataSource.DataSource did not run to completion. It is not usable.DataSource is marked as deleted. It is not usable.The current status of the DataSource. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.
INPROGRESS - The creation process is underway.
FAILED - The request to create a DataSource did not run to completion. It is not usable.
COMPLETED - The creation process completed successfully.
DELETED - The DataSource is marked as deleted. It is not usable.
A list of the variables to use in searching or filtering DataSource.
CreatedAt - Sets the search criteria to DataSource creation date.
Status - Sets the search criteria to DataSource status.
Name - Sets the search criteria to the contents of DataSource Name.
DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
Note: The variable names should match the variable names in the DataSource.
A list of the variables to use in searching or filtering DataSource.
CreatedAt - Sets the search criteria to DataSource creation date.Status - Sets the search criteria to DataSource status.Name - Sets the search criteria to the contents of DataSource Name.DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.The variable names should match the variable names in the DataSource.
The type of the ML object from which tags were deleted.
" } }, - "documentation":"Amazon ML returns the following elements.
" + "documentation":"Amazon ML returns the following elements.
" }, "DescribeBatchPredictionsInput":{ "type":"structure", "members":{ "FilterVariable":{ "shape":"BatchPredictionFilterVariable", - "documentation":"Use one of the following variables to filter a list of BatchPrediction:
CreatedAt - Sets the search criteria to the BatchPrediction creation date.Status - Sets the search criteria to the BatchPrediction status.Name - Sets the search criteria to the contents of the BatchPrediction Name.IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.Use one of the following variables to filter a list of BatchPrediction:
CreatedAt - Sets the search criteria to the BatchPrediction creation date.
Status - Sets the search criteria to the BatchPrediction status.
Name - Sets the search criteria to the contents of the BatchPrediction Name.
IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
A string that is found at the beginning of a variable, such as Name or Id.
For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A string that is found at the beginning of a variable, such as Name or Id.
For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A two-value parameter that determines the sequence of the resulting list of MLModels.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
A two-value parameter that determines the sequence of the resulting list of MLModels.
asc - Arranges the list in ascending order (A-Z, 0-9).
dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
Use one of the following variables to filter a list of DataSource:
CreatedAt - Sets the search criteria to DataSource creation dates.Status - Sets the search criteria to DataSource statuses.Name - Sets the search criteria to the contents of DataSource Name.DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.Use one of the following variables to filter a list of DataSource:
CreatedAt - Sets the search criteria to DataSource creation dates.
Status - Sets the search criteria to DataSource statuses.
Name - Sets the search criteria to the contents of DataSource Name.
DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
A string that is found at the beginning of a variable, such as Name or Id.
For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A string that is found at the beginning of a variable, such as Name or Id.
For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A two-value parameter that determines the sequence of the resulting list of DataSource.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
A two-value parameter that determines the sequence of the resulting list of DataSource.
asc - Arranges the list in ascending order (A-Z, 0-9).
dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
Use one of the following variable to filter a list of Evaluation objects:
CreatedAt - Sets the search criteria to the Evaluation creation date.Status - Sets the search criteria to the Evaluation status.Name - Sets the search criteria to the contents of Evaluation Name.IAMUser - Sets the search criteria to the user account that invoked an Evaluation.MLModelId - Sets the search criteria to the MLModel that was evaluated.DataSourceId - Sets the search criteria to the DataSource used in Evaluation.DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.Use one of the following variable to filter a list of Evaluation objects:
CreatedAt - Sets the search criteria to the Evaluation creation date.
Status - Sets the search criteria to the Evaluation status.
Name - Sets the search criteria to the contents of Evaluation Name.
IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
MLModelId - Sets the search criteria to the MLModel that was evaluated.
DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
A string that is found at the beginning of a variable, such as Name or Id.
For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A string that is found at the beginning of a variable, such as Name or Id.
For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A two-value parameter that determines the sequence of the resulting list of Evaluation.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
A two-value parameter that determines the sequence of the resulting list of Evaluation.
asc - Arranges the list in ascending order (A-Z, 0-9).
dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
Use one of the following variables to filter a list of MLModel:
CreatedAt - Sets the search criteria to MLModel creation date.Status - Sets the search criteria to MLModel status.Name - Sets the search criteria to the contents of MLModel Name.IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.Algorithm - Sets the search criteria to the algorithm that the MLModel uses.TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.Use one of the following variables to filter a list of MLModel:
CreatedAt - Sets the search criteria to MLModel creation date.
Status - Sets the search criteria to MLModel status.
Name - Sets the search criteria to the contents of MLModel Name.
IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
A string that is found at the beginning of a variable, such as Name or Id.
For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A string that is found at the beginning of a variable, such as Name or Id.
For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:
2014-09
2014-09-09
2014-09-09-Holiday
A two-value parameter that determines the sequence of the resulting list of MLModel.
asc - Arranges the list in ascending order (A-Z, 0-9).dsc - Arranges the list in descending order (Z-A, 9-0).Results are sorted by FilterVariable.
A two-value parameter that determines the sequence of the resulting list of MLModel.
asc - Arranges the list in ascending order (A-Z, 0-9).
dsc - Arranges the list in descending order (Z-A, 9-0).
Results are sorted by FilterVariable.
A list of tags associated with the ML object.
" } }, - "documentation":"Amazon ML returns the following elements.
" + "documentation":"Amazon ML returns the following elements.
" }, "DetailsAttributes":{ "type":"string", + "documentation":"Contains the key values of DetailsMap:
PredictiveModelType - Indicates the type of the MLModel.
Algorithm - Indicates the algorithm that was used for the MLModel.
DetailsMap: PredictiveModelType - Indicates the type of the MLModel. Algorithm - Indicates the algorithm that was used for the MLModel."
+ ]
},
"DetailsMap":{
"type":"map",
"key":{"shape":"DetailsAttributes"},
"value":{"shape":"DetailsValue"},
- "documentation":"Provides any additional details regarding the prediction."
+ "documentation":"Provides any additional details regarding the prediction.
" }, "DetailsValue":{ "type":"string", @@ -1883,18 +1354,18 @@ }, "EDPPipelineId":{ "type":"string", - "min":1, - "max":1024 + "max":1024, + "min":1 }, "EDPResourceRole":{ "type":"string", - "min":1, - "max":64 + "max":64, + "min":1 }, "EDPSecurityGroupId":{ "type":"string", - "min":1, - "max":255 + "max":255, + "min":1 }, "EDPSecurityGroupIds":{ "type":"list", @@ -1902,36 +1373,36 @@ }, "EDPServiceRole":{ "type":"string", - "min":1, - "max":64 + "max":64, + "min":1 }, "EDPSubnetId":{ "type":"string", - "min":1, - "max":255 + "max":255, + "min":1 }, "EntityId":{ "type":"string", - "min":1, "max":64, + "min":1, "pattern":"[a-zA-Z0-9_.-]+" }, "EntityName":{ "type":"string", + "documentation":"A user-supplied name or description of the Amazon ML resource.
", "max":1024, - "pattern":".*\\S.*|^$", - "documentation":"A user-supplied name or description of the Amazon ML resource.
" + "pattern":".*\\S.*|^$" }, "EntityStatus":{ "type":"string", + "documentation":"Object status with the following possible values:
PENDING
INPROGRESS
FAILED
COMPLETED
DELETED
Object status with the following possible values:
PENDINGINPROGRESSFAILEDCOMPLETEDDELETEDThe status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.INPROGRESS - The evaluation is underway.FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.COMPLETED - The evaluation process completed successfully.DELETED - The Evaluation is marked as deleted. It is not usable.The status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.
INPROGRESS - The evaluation is underway.
FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
COMPLETED - The evaluation process completed successfully.
DELETED - The Evaluation is marked as deleted. It is not usable.
Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
" + "documentation":"Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
" }, "Message":{ "shape":"Message", @@ -1997,6 +1468,7 @@ }, "EvaluationFilterVariable":{ "type":"string", + "documentation":"A list of the variables to use in searching or filtering Evaluation.
CreatedAt - Sets the search criteria to Evaluation creation date.
Status - Sets the search criteria to Evaluation status.
Name - Sets the search criteria to the contents of Evaluation Name.
IAMUser - Sets the search criteria to the user account that invoked an evaluation.
MLModelId - Sets the search criteria to the Predictor that was evaluated.
DataSourceId - Sets the search criteria to the DataSource used in evaluation.
DataUri - Sets the search criteria to the data file(s) used in evaluation. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
A list of the variables to use in searching or filtering Evaluation.
CreatedAt - Sets the search criteria to Evaluation creation date.Status - Sets the search criteria to Evaluation status.Name - Sets the search criteria to the contents of Evaluation Name.IAMUser - Sets the search criteria to the user account that invoked an evaluation.MLModelId - Sets the search criteria to the Predictor that was evaluated.DataSourceId - Sets the search criteria to the DataSource used in evaluation.DataUri - Sets the search criteria to the data file(s) used in evaluation. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.The status of the BatchPrediction, which can be one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.INPROGRESS - The batch predictions are in progress.FAILED - The request to perform a batch prediction did not run to completion. It is not usable.COMPLETED - The batch prediction process completed successfully.DELETED - The BatchPrediction is marked as deleted. It is not usable.The status of the BatchPrediction, which can be one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
INPROGRESS - The batch predictions are in progress.
FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
COMPLETED - The batch prediction process completed successfully.
DELETED - The BatchPrediction is marked as deleted. It is not usable.
The current status of the DataSource. This element can have one of the following values:
PENDING - Amazon ML submitted a request to create a DataSource.INPROGRESS - The creation process is underway.FAILED - The request to create a DataSource did not run to completion. It is not usable.COMPLETED - The creation process completed successfully.DELETED - The DataSource is marked as deleted. It is not usable.The current status of the DataSource. This element can have one of the following values:
PENDING - Amazon ML submitted a request to create a DataSource.
INPROGRESS - The creation process is underway.
FAILED - The request to create a DataSource did not run to completion. It is not usable.
COMPLETED - The creation process completed successfully.
DELETED - The DataSource is marked as deleted. It is not usable.
The schema used by all of the data files of this DataSource.
This parameter is provided as part of the verbose format.
The schema used by all of the data files of this DataSource.
Note: This parameter is provided as part of the verbose format.
" } }, "documentation":"Represents the output of a GetDataSource operation and describes a DataSource.
The status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Language (Amazon ML) submitted a request to evaluate an MLModel.INPROGRESS - The evaluation is underway.FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.COMPLETED - The evaluation process completed successfully.DELETED - The Evaluation is marked as deleted. It is not usable.The status of the evaluation. This element can have one of the following values:
PENDING - Amazon Machine Language (Amazon ML) submitted a request to evaluate an MLModel.
INPROGRESS - The evaluation is underway.
FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
COMPLETED - The evaluation process completed successfully.
DELETED - The Evaluation is marked as deleted. It is not usable.
Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
" + "documentation":"Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel:
BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
" }, "LogUri":{ "shape":"PresignedS3Url", @@ -2283,7 +1754,7 @@ "members":{ "MLModelId":{ "shape":"EntityId", - "documentation":"The MLModel ID, which is same as the MLModelId in the request.
The MLModel ID, which is same as the MLModelId in the request.
The current status of the MLModel. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.INPROGRESS - The request is processing.FAILED - The request did not run to completion. The ML model isn't usable.COMPLETED - The request completed successfully.DELETED - The MLModel is marked as deleted. It isn't usable.The current status of the MLModel. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.
INPROGRESS - The request is processing.
FAILED - The request did not run to completion. The ML model isn't usable.
COMPLETED - The request completed successfully.
DELETED - The MLModel is marked as deleted. It isn't usable.
The current endpoint of the MLModel
The current endpoint of the MLModel
A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
Identifies the MLModel category. The following are the available types:
Identifies the MLModel category. The following are the available types:
REGRESSION -- Produces a numeric result. For example, \"What price should a house be listed at?\"
BINARY -- Produces one of two possible results. For example, \"Is this an e-commerce website?\"
MULTICLASS -- Produces one of several possible results. For example, \"Is this a HIGH, LOW or MEDIUM risk trade?\"
The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.
Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.
The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.
Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.
The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.
This parameter is provided as part of the verbose format.
The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.
Note: This parameter is provided as part of the verbose format.
" }, "Schema":{ "shape":"DataSchema", - "documentation":"The schema used by all of the data files referenced by the DataSource.
This parameter is provided as part of the verbose format.
The schema used by all of the data files referenced by the DataSource.
Note: This parameter is provided as part of the verbose format.
" } }, "documentation":"Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.
A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
" + "documentation":"A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.
", + "exception":true }, "IntegerType":{ "type":"integer", @@ -2385,10 +1855,9 @@ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, - "error":{"httpStatusCode":500}, + "documentation":"An error on the server occurred when trying to process a request.
", "exception":true, - "fault":true, - "documentation":"An error on the server occurred when trying to process a request.
" + "fault":true }, "InvalidInputException":{ "type":"structure", @@ -2396,9 +1865,8 @@ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, - "error":{"httpStatusCode":400}, - "exception":true, - "documentation":"An error on the client occurred. Typically, the cause is an invalid input value.
" + "documentation":"An error on the client occurred. Typically, the cause is an invalid input value.
", + "exception":true }, "InvalidTagException":{ "type":"structure", @@ -2417,9 +1885,8 @@ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, - "error":{"httpStatusCode":417}, - "exception":true, - "documentation":"The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.
The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.
The current status of an MLModel. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel.INPROGRESS - The creation process is underway.FAILED - The request to create an MLModel didn't run to completion. The model isn't usable.COMPLETED - The creation process completed successfully.DELETED - The MLModel is marked as deleted. It isn't usable.The current status of an MLModel. This element can have one of the following values:
PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel.
INPROGRESS - The creation process is underway.
FAILED - The request to create an MLModel didn't run to completion. The model isn't usable.
COMPLETED - The creation process completed successfully.
DELETED - The MLModel is marked as deleted. It isn't usable.
A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.
The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.
sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.
sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none.
sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.
The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
The algorithm used to train the MLModel. The following algorithm is supported:
SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function. The algorithm used to train the MLModel. The following algorithm is supported:
SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function.
Identifies the MLModel category. The following are the available types:
REGRESSION - Produces a numeric result. For example, \"What price should a house be listed at?\"BINARY - Produces one of two possible results. For example, \"Is this a child-friendly web site?\".MULTICLASS - Produces one of several possible results. For example, \"Is this a HIGH-, LOW-, or MEDIUM-risk trade?\".Identifies the MLModel category. The following are the available types:
REGRESSION - Produces a numeric result. For example, \"What price should a house be listed at?\"
BINARY - Produces one of two possible results. For example, \"Is this a child-friendly web site?\".
MULTICLASS - Produces one of several possible results. For example, \"Is this a HIGH-, LOW-, or MEDIUM-risk trade?\".
Description of the most recent details about an object.
" + "documentation":"Description of the most recent details about an object.
", + "max":10240 }, "PageLimit":{ "type":"integer", - "min":1, - "max":100 + "max":100, + "min":1 }, "PerformanceMetrics":{ "type":"structure", "members":{ "Properties":{"shape":"PerformanceMetricsProperties"} }, - "documentation":"Measurements of how well the MLModel performed on known observations. One of the following metrics is returned, based on the type of the MLModel:
BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: The regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
" + "documentation":"Measurements of how well the MLModel performed on known observations. One of the following metrics is returned, based on the type of the MLModel:
BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: The regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
" }, "PerformanceMetricsProperties":{ "type":"map", @@ -2578,7 +2045,7 @@ }, "predictedValue":{ "shape":"floatLabel", - "documentation":"The prediction value forREGRESSION MLModel."
+ "documentation":"The prediction value for REGRESSION MLModel.
The exception is thrown when a predict request is made to an unmounted MLModel.
The exception is thrown when a predict request is made to an unmounted MLModel.
A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
A DataSchema is not required if you specify a DataSchemaUri
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
" + "documentation":"A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
A DataSchema is not required if you specify a DataSchemaUri
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
" }, "DataSchemaUri":{ "shape":"S3Url", @@ -2638,11 +2104,11 @@ }, "ResourceRole":{ "shape":"EDPResourceRole", - "documentation":"The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
" + "documentation":"The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
" }, "ServiceRole":{ "shape":"EDPServiceRole", - "documentation":"The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" + "documentation":"The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" }, "SubnetId":{ "shape":"EDPSubnetId", @@ -2684,28 +2150,28 @@ }, "RDSDatabaseName":{ "type":"string", - "min":1, + "documentation":"The name of a database hosted on an RDS DB instance.
", "max":64, - "documentation":"The name of a database hosted on an RDS DB instance.
" + "min":1 }, "RDSDatabasePassword":{ "type":"string", - "min":8, + "documentation":"The password to be used by Amazon ML to connect to a database on an RDS DB instance. The password should have sufficient permissions to execute the RDSSelectQuery query.
The password to be used by Amazon ML to connect to a database on an RDS DB instance. The password should have sufficient permissions to execute the RDSSelectQuery query.
The username to be used by Amazon ML to connect to database on an Amazon RDS instance. The username should have sufficient permissions to execute an RDSSelectSqlQuery query.
The username to be used by Amazon ML to connect to database on an Amazon RDS instance. The username should have sufficient permissions to execute an RDSSelectSqlQuery query.
The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" + "documentation":"The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" }, "ServiceRole":{ "shape":"EDPServiceRole", - "documentation":"The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" + "documentation":"The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
" }, "DataPipelineId":{ "shape":"EDPPipelineId", @@ -2736,9 +2202,9 @@ }, "RDSSelectSqlQuery":{ "type":"string", - "min":1, + "documentation":"The SQL query to be executed against the Amazon RDS database. The SQL query should be valid for the Amazon RDS type being used.
", "max":16777216, - "documentation":"The SQL query to be executed against the Amazon RDS database. The SQL query should be valid for the Amazon RDS type being used.
" + "min":1 }, "RealtimeEndpointInfo":{ "type":"structure", @@ -2753,11 +2219,11 @@ }, "EndpointUrl":{ "shape":"VipURL", - "documentation":"The URI that specifies where to send real-time prediction requests for the MLModel.
The application must wait until the real-time endpoint is ready before using this URI.
The URI that specifies where to send real-time prediction requests for the MLModel.
Note: The application must wait until the real-time endpoint is ready before using this URI.
" }, "EndpointStatus":{ "shape":"RealtimeEndpointStatus", - "documentation":" The current status of the real-time endpoint for the MLModel. This element can have one of the following values:
NONE - Endpoint does not exist or was previously deleted.READY - Endpoint is ready to be used for real-time predictions.UPDATING - Updating/creating the endpoint. The current status of the real-time endpoint for the MLModel. This element can have one of the following values:
NONE - Endpoint does not exist or was previously deleted.
READY - Endpoint is ready to be used for real-time predictions.
UPDATING - Updating/creating the endpoint.
Describes the real-time endpoint information for an MLModel.
The ID of an Amazon Redshift cluster.
", "max":63, - "pattern":"[a-z0-9-]+", - "documentation":"The ID of an Amazon Redshift cluster.
" + "min":1, + "pattern":"[a-z0-9-]+" }, "RedshiftDataSpec":{ "type":"structure", @@ -2815,11 +2281,11 @@ }, "DataRearrangement":{ "shape":"DataRearrangement", - "documentation":"A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the schema for an Amazon Redshift DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
A DataSchema is not required if you specify a DataSchemaUri.
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
" + "documentation":"A JSON string that represents the schema for an Amazon Redshift DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
A DataSchema is not required if you specify a DataSchemaUri.
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
" }, "DataSchemaUri":{ "shape":"S3Url", @@ -2850,26 +2316,26 @@ "Username":{"shape":"RedshiftDatabaseUsername"}, "Password":{"shape":"RedshiftDatabasePassword"} }, - "documentation":"Describes the database credentials for connecting to a database on an Amazon Redshift cluster.
" + "documentation":"Describes the database credentials for connecting to a database on an Amazon Redshift cluster.
" }, "RedshiftDatabaseName":{ "type":"string", - "min":1, + "documentation":"The name of a database hosted on an Amazon Redshift cluster.
", "max":64, - "pattern":"[a-z0-9]+", - "documentation":"The name of a database hosted on an Amazon Redshift cluster.
" + "min":1, + "pattern":"[a-z0-9]+" }, "RedshiftDatabasePassword":{ "type":"string", - "min":8, + "documentation":"A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster. The password should have sufficient permissions to execute a RedshiftSelectSqlQuery query. The password should be valid for an Amazon Redshift USER.
A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster. The password should have sufficient permissions to execute a RedshiftSelectSqlQuery query. The password should be valid for an Amazon Redshift USER.
A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster. The username should have sufficient permissions to execute the RedshiftSelectSqlQuery query. The username should be valid for an Amazon Redshift USER.
A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster. The username should have sufficient permissions to execute the RedshiftSelectSqlQuery query. The username should be valid for an Amazon Redshift USER.
Describes the SQL query to execute on the Amazon Redshift database. The SQL query should be valid for an Amazon Redshift SELECT.
", "max":16777216, - "documentation":"Describes the SQL query to execute on the Amazon Redshift database. The SQL query should be valid for an Amazon Redshift SELECT.
" + "min":1 }, "ResourceNotFoundException":{ "type":"structure", @@ -2895,15 +2361,14 @@ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, - "error":{"httpStatusCode":404}, - "exception":true, - "documentation":"A specified resource cannot be located.
" + "documentation":"A specified resource cannot be located.
", + "exception":true }, "RoleARN":{ "type":"string", - "min":1, + "documentation":"The Amazon Resource Name (ARN) of an AWS IAM Role, such as the following: arn:aws:iam::account:role/rolename.
", "max":110, - "documentation":"The Amazon Resource Name (ARN) of an AWS IAM Role, such as the following: arn:aws:iam::account:role/rolename.
" + "min":1 }, "S3DataSpec":{ "type":"structure", @@ -2915,11 +2380,11 @@ }, "DataRearrangement":{ "shape":"DataRearrangement", - "documentation":"A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.
There are multiple parameters that control what data is used to create a datasource:
percentBegin
Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
percentEnd
Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.
complement
The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.
For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}
Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}
strategy
To change how Amazon ML splits the data for a datasource, use the strategy parameter.
The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.
The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.
The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:
Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}
Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}
A JSON string that represents the schema for an Amazon S3 DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
You must provide either the DataSchema or the DataSchemaLocationS3.
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
" + "documentation":" A JSON string that represents the schema for an Amazon S3 DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.
You must provide either the DataSchema or the DataSchemaLocationS3.
Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.
{ \"version\": \"1.0\",
\"recordAnnotationFieldName\": \"F1\",
\"recordWeightFieldName\": \"F2\",
\"targetFieldName\": \"F3\",
\"dataFormat\": \"CSV\",
\"dataFileContainsHeader\": true,
\"attributes\": [
{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],
\"excludedVariableNames\": [ \"F6\" ] }
" }, "DataSchemaLocationS3":{ "shape":"S3Url", @@ -2930,9 +2395,9 @@ }, "S3Url":{ "type":"string", + "documentation":"A reference to a file or bucket on Amazon Simple Storage Service (Amazon S3).
", "max":2048, - "pattern":"s3://([^/]+)(/.*)?", - "documentation":"A reference to a file or bucket on Amazon Simple Storage Service (Amazon S3).
" + "pattern":"s3://([^/]+)(/.*)?" }, "ScoreThreshold":{"type":"float"}, "ScoreValue":{"type":"float"}, @@ -2940,15 +2405,15 @@ "type":"map", "key":{"shape":"Label"}, "value":{"shape":"ScoreValue"}, - "documentation":"Provides the raw classification score corresponding to each label." + "documentation":"Provides the raw classification score corresponding to each label.
" }, "SortOrder":{ "type":"string", + "documentation":"The sort order specified in a listing condition. Possible values include the following:
asc - Present the information in ascending order (from A-Z).
dsc - Present the information in descending order (from Z-A).
The sort order specified in a listing condition. Possible values include the following:
asc - Present the information in ascending order (from A-Z).dsc - Present the information in descending order (from Z-A).The name of the thing type used to search for things.
", "location":"querystring", "locationName":"thingTypeName" + }, + "usePrefixAttributeValue":{ + "shape":"usePrefixAttributeValue", + "documentation":"When true, the action returns the thing resources with attribute values that start with the attributeValue provided.
When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.
The input for the ListThings operation.
" @@ -17674,7 +17680,8 @@ "errorMessage":{"type":"string"}, "resourceArn":{"type":"string"}, "resourceId":{"type":"string"}, - "stringValue":{"type":"string"} + "stringValue":{"type":"string"}, + "usePrefixAttributeValue":{"type":"boolean"} }, "documentation":"AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in AWS IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
" } From f727a27b6f1c9f869ec574e82c8680faf0ef5b89 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:27 +0000 Subject: [PATCH 14/19] Amazon Cognito Sync Update: Minor documentation updates and link updates. --- .../feature-AmazonCognitoSync-ab91ead.json | 6 + .../codegen-resources/paginators-1.json | 4 + .../codegen-resources/service-2.json | 1504 +++-------------- 3 files changed, 278 insertions(+), 1236 deletions(-) create mode 100644 .changes/next-release/feature-AmazonCognitoSync-ab91ead.json create mode 100644 services/cognitosync/src/main/resources/codegen-resources/paginators-1.json diff --git a/.changes/next-release/feature-AmazonCognitoSync-ab91ead.json b/.changes/next-release/feature-AmazonCognitoSync-ab91ead.json new file mode 100644 index 000000000000..59323eef698f --- /dev/null +++ b/.changes/next-release/feature-AmazonCognitoSync-ab91ead.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Cognito Sync", + "contributor": "", + "description": "Minor documentation updates and link updates." +} diff --git a/services/cognitosync/src/main/resources/codegen-resources/paginators-1.json b/services/cognitosync/src/main/resources/codegen-resources/paginators-1.json new file mode 100644 index 000000000000..5677bd8e4a2d --- /dev/null +++ b/services/cognitosync/src/main/resources/codegen-resources/paginators-1.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/services/cognitosync/src/main/resources/codegen-resources/service-2.json b/services/cognitosync/src/main/resources/codegen-resources/service-2.json index 7fa8b3ec0130..9859d0efa7dd 100644 --- a/services/cognitosync/src/main/resources/codegen-resources/service-2.json +++ b/services/cognitosync/src/main/resources/codegen-resources/service-2.json @@ -4,13 +4,12 @@ "apiVersion":"2014-06-30", "endpointPrefix":"cognito-sync", "jsonVersion":"1.1", + "protocol":"rest-json", "serviceFullName":"Amazon Cognito Sync", - "serviceId": "Cognito Sync", + "serviceId":"Cognito Sync", "signatureVersion":"v4", - "protocol":"rest-json", "uid":"cognito-sync-2014-06-30" }, - "documentation":"Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.
With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.
If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
", "operations":{ "BulkPublish":{ "name":"BulkPublish", @@ -19,77 +18,17 @@ "requestUri":"/identitypools/{IdentityPoolId}/bulkpublish", "responseCode":200 }, - "input":{ - "shape":"BulkPublishRequest", - "documentation":"The input for the BulkPublish operation." - }, - "output":{ - "shape":"BulkPublishResponse", - "documentation":"The output for the BulkPublish operation." - }, + "input":{"shape":"BulkPublishRequest"}, + "output":{"shape":"BulkPublishResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"DuplicateRequestException", - "error":{ - "code":"DuplicateRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool." - }, - { - "shape":"AlreadyStreamedException", - "error":{ - "code":"AlreadyStreamed", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"DuplicateRequestException"}, + {"shape":"AlreadyStreamedException"} ], - "documentation":"Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" + "documentation":"Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" }, "DeleteDataset":{ "name":"DeleteDataset", @@ -98,75 +37,15 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", "responseCode":200 }, - "input":{ - "shape":"DeleteDatasetRequest", - "documentation":"A request to delete the specific dataset." - }, - "output":{ - "shape":"DeleteDatasetResponse", - "documentation":"Response to a successful DeleteDataset request." - }, + "input":{"shape":"DeleteDatasetRequest"}, + "output":{"shape":"DeleteDatasetResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - }, - { - "shape":"ResourceConflictException", - "error":{ - "code":"ResourceConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceConflictException"} ], "documentation":"Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
" }, @@ -177,65 +56,14 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", "responseCode":200 }, - "input":{ - "shape":"DescribeDatasetRequest", - "documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name." - }, - "output":{ - "shape":"DescribeDatasetResponse", - "documentation":"Response to a successful DescribeDataset request." - }, + "input":{"shape":"DescribeDatasetRequest"}, + "output":{"shape":"DescribeDatasetResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], "documentation":"Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
" }, @@ -246,65 +74,14 @@ "requestUri":"/identitypools/{IdentityPoolId}", "responseCode":200 }, - "input":{ - "shape":"DescribeIdentityPoolUsageRequest", - "documentation":"A request for usage information about the identity pool." - }, - "output":{ - "shape":"DescribeIdentityPoolUsageResponse", - "documentation":"Response to a successful DescribeIdentityPoolUsage request." - }, + "input":{"shape":"DescribeIdentityPoolUsageRequest"}, + "output":{"shape":"DescribeIdentityPoolUsageResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], "documentation":"Gets usage details (for example, data storage) about a particular identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" }, @@ -315,65 +92,14 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}", "responseCode":200 }, - "input":{ - "shape":"DescribeIdentityUsageRequest", - "documentation":"A request for information about the usage of an identity pool." - }, - "output":{ - "shape":"DescribeIdentityUsageResponse", - "documentation":"The response to a successful DescribeIdentityUsage request." - }, + "input":{"shape":"DescribeIdentityUsageRequest"}, + "output":{"shape":"DescribeIdentityUsageResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], "documentation":"Gets usage information for an identity, including number of datasets and data usage.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
" }, @@ -384,57 +110,15 @@ "requestUri":"/identitypools/{IdentityPoolId}/getBulkPublishDetails", "responseCode":200 }, - "input":{ - "shape":"GetBulkPublishDetailsRequest", - "documentation":"The input for the GetBulkPublishDetails operation." - }, - "output":{ - "shape":"GetBulkPublishDetailsResponse", - "documentation":"The output for the GetBulkPublishDetails operation." - }, + "input":{"shape":"GetBulkPublishDetailsRequest"}, + "output":{"shape":"GetBulkPublishDetailsResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} ], - "documentation":"Get the status of the last BulkPublish operation for an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" + "documentation":"Get the status of the last BulkPublish operation for an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" }, "GetCognitoEvents":{ "name":"GetCognitoEvents", @@ -443,67 +127,16 @@ "requestUri":"/identitypools/{IdentityPoolId}/events", "responseCode":200 }, - "input":{ - "shape":"GetCognitoEventsRequest", - "documentation":"A request for a list of the configured Cognito Events
" - }, - "output":{ - "shape":"GetCognitoEventsResponse", - "documentation":"The response from the GetCognitoEvents request
" - }, + "input":{"shape":"GetCognitoEventsRequest"}, + "output":{"shape":"GetCognitoEventsResponse"}, "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], - "documentation":"Gets the events and the corresponding Lambda functions associated with an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" + "documentation":"Gets the events and the corresponding Lambda functions associated with an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" }, "GetIdentityPoolConfiguration":{ "name":"GetIdentityPoolConfiguration", @@ -512,67 +145,16 @@ "requestUri":"/identitypools/{IdentityPoolId}/configuration", "responseCode":200 }, - "input":{ - "shape":"GetIdentityPoolConfigurationRequest", - "documentation":"The input for the GetIdentityPoolConfiguration operation.
" - }, - "output":{ - "shape":"GetIdentityPoolConfigurationResponse", - "documentation":"The output for the GetIdentityPoolConfiguration operation.
" - }, + "input":{"shape":"GetIdentityPoolConfigurationRequest"}, + "output":{"shape":"GetIdentityPoolConfigurationResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], - "documentation":"Gets the configuration settings of an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" + "documentation":"Gets the configuration settings of an identity pool.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" }, "ListDatasets":{ "name":"ListDatasets", @@ -581,55 +163,13 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets", "responseCode":200 }, - "input":{ - "shape":"ListDatasetsRequest", - "documentation":"Request for a list of datasets for an identity." - }, - "output":{ - "shape":"ListDatasetsResponse", - "documentation":"Returned for a successful ListDatasets request." - }, + "input":{"shape":"ListDatasetsRequest"}, + "output":{"shape":"ListDatasetsResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], "documentation":"Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.
" }, @@ -640,55 +180,13 @@ "requestUri":"/identitypools", "responseCode":200 }, - "input":{ - "shape":"ListIdentityPoolUsageRequest", - "documentation":"A request for usage information on an identity pool." - }, - "output":{ - "shape":"ListIdentityPoolUsageResponse", - "documentation":"Returned for a successful ListIdentityPoolUsage request." - }, + "input":{"shape":"ListIdentityPoolUsageRequest"}, + "output":{"shape":"ListIdentityPoolUsageResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], "documentation":"Gets a list of identity pools registered with Cognito.
ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.
" }, @@ -699,55 +197,13 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records", "responseCode":200 }, - "input":{ - "shape":"ListRecordsRequest", - "documentation":"A request for a list of records." - }, - "output":{ - "shape":"ListRecordsResponse", - "documentation":"Returned for a successful ListRecordsRequest." - }, + "input":{"shape":"ListRecordsRequest"}, + "output":{"shape":"ListRecordsResponse"}, "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} ], "documentation":"Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
" }, @@ -758,76 +214,17 @@ "requestUri":"/identitypools/{IdentityPoolId}/identity/{IdentityId}/device", "responseCode":200 }, - "input":{ - "shape":"RegisterDeviceRequest", - "documentation":"A request to RegisterDevice.
" - }, - "output":{ - "shape":"RegisterDeviceResponse", - "documentation":"Response to a RegisterDevice request.
" - }, + "input":{"shape":"RegisterDeviceRequest"}, + "output":{"shape":"RegisterDeviceResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"InvalidConfigurationException", - "error":{ - "code":"InvalidConfiguration", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidConfigurationException"}, + {"shape":"TooManyRequestsException"} ], - "documentation":"Registers a device to receive push sync notifications.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
" + "documentation":"Registers a device to receive push sync notifications.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
" }, "SetCognitoEvents":{ "name":"SetCognitoEvents", @@ -836,63 +233,15 @@ "requestUri":"/identitypools/{IdentityPoolId}/events", "responseCode":200 }, - "input":{ - "shape":"SetCognitoEventsRequest", - "documentation":"A request to configure Cognito Events\"
\"" - }, + "input":{"shape":"SetCognitoEventsRequest"}, "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"} ], - "documentation":"Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" + "documentation":"Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" }, "SetIdentityPoolConfiguration":{ "name":"SetIdentityPoolConfiguration", @@ -901,77 +250,17 @@ "requestUri":"/identitypools/{IdentityPoolId}/configuration", "responseCode":200 }, - "input":{ - "shape":"SetIdentityPoolConfigurationRequest", - "documentation":"The input for the SetIdentityPoolConfiguration operation.
" - }, - "output":{ - "shape":"SetIdentityPoolConfigurationResponse", - "documentation":"The output for the SetIdentityPoolConfiguration operation
" - }, + "input":{"shape":"SetIdentityPoolConfigurationRequest"}, + "output":{"shape":"SetIdentityPoolConfigurationResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - }, - { - "shape":"ConcurrentModificationException", - "error":{ - "code":"ConcurrentModification", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if there are parallel requests to modify a resource.
" - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ConcurrentModificationException"} ], - "documentation":"Sets the necessary configuration for push sync.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" + "documentation":"Sets the necessary configuration for push sync.
This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
" }, "SubscribeToDataset":{ "name":"SubscribeToDataset", @@ -980,76 +269,17 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", "responseCode":200 }, - "input":{ - "shape":"SubscribeToDatasetRequest", - "documentation":"A request to SubscribeToDatasetRequest.
" - }, - "output":{ - "shape":"SubscribeToDatasetResponse", - "documentation":"Response to a SubscribeToDataset request.
" - }, + "input":{"shape":"SubscribeToDatasetRequest"}, + "output":{"shape":"SubscribeToDatasetResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"InvalidConfigurationException", - "error":{ - "code":"InvalidConfiguration", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidConfigurationException"}, + {"shape":"TooManyRequestsException"} ], - "documentation":"Subscribes to receive notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
" + "documentation":"Subscribes to receive notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
" }, "UnsubscribeFromDataset":{ "name":"UnsubscribeFromDataset", @@ -1058,76 +288,17 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", "responseCode":200 }, - "input":{ - "shape":"UnsubscribeFromDatasetRequest", - "documentation":"A request to UnsubscribeFromDataset.
" - }, - "output":{ - "shape":"UnsubscribeFromDatasetResponse", - "documentation":"Response to an UnsubscribeFromDataset request.
" - }, + "input":{"shape":"UnsubscribeFromDatasetRequest"}, + "output":{"shape":"UnsubscribeFromDatasetResponse"}, "errors":[ - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - }, - { - "shape":"InvalidConfigurationException", - "error":{ - "code":"InvalidConfiguration", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - } + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidConfigurationException"}, + {"shape":"TooManyRequestsException"} ], - "documentation":"Unsubscribes from receiving notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
" + "documentation":"Unsubscribes from receiving notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
" }, "UpdateRecords":{ "name":"UpdateRecords", @@ -1136,107 +307,20 @@ "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", "responseCode":200 }, - "input":{ - "shape":"UpdateRecordsRequest", - "documentation":"A request to post updates to records or add and delete records for a dataset and user." - }, - "output":{ - "shape":"UpdateRecordsResponse", - "documentation":"Returned for a successful UpdateRecordsRequest." - }, + "input":{"shape":"UpdateRecordsRequest"}, + "output":{"shape":"UpdateRecordsResponse"}, "errors":[ - { - "shape":"InvalidParameterException", - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." - }, - { - "shape":"LimitExceededException", - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." - }, - { - "shape":"NotAuthorizedException", - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." - }, - { - "shape":"ResourceNotFoundException", - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." - }, - { - "shape":"ResourceConflictException", - "error":{ - "code":"ResourceConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." - }, - { - "shape":"InvalidLambdaFunctionOutputException", - "error":{ - "code":"InvalidLambdaFunctionOutput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The AWS Lambda function returned invalid output or an exception.
" - }, - { - "shape":"LambdaThrottledException", - "error":{ - "code":"LambdaThrottled", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"AWS Lambda throttled your account, please contact AWS Support
" - }, - { - "shape":"TooManyRequestsException", - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." - }, - { - "shape":"InternalErrorException", - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, - "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." - } + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"InvalidLambdaFunctionOutputException"}, + {"shape":"LambdaThrottledException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} ], - "documentation":"Posts updates to records and adds and deletes records for a dataset and user.
The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.
For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
" + "documentation":"Posts updates to records and adds and deletes records for a dataset and user.
The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.
For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
" } }, "shapes":{ @@ -1249,13 +333,9 @@ "documentation":"The message associated with the AlreadyStreamedException exception." } }, - "error":{ - "code":"AlreadyStreamed", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully." + "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully.", + "error":{"httpStatusCode":400}, + "exception":true }, "ApplicationArn":{ "type":"string", @@ -1267,8 +347,8 @@ }, "AssumeRoleArn":{ "type":"string", - "min":20, "max":2048, + "min":20, "pattern":"arn:aws:iam::\\d+:role/.*" }, "Boolean":{"type":"boolean"}, @@ -1278,9 +358,9 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" } }, "documentation":"The input for the BulkPublish operation." @@ -1333,13 +413,9 @@ "documentation":"The message returned by a ConcurrentModicationException.
" } }, - "error":{ - "code":"ConcurrentModification", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if there are parallel requests to modify a resource.
" + "documentation":"Thrown if there are parallel requests to modify a resource.
", + "error":{"httpStatusCode":400}, + "exception":true }, "Dataset":{ "type":"structure", @@ -1381,8 +457,8 @@ }, "DatasetName":{ "type":"string", - "min":1, "max":128, + "min":1, "pattern":"[a-zA-Z0-9_.:-]+" }, "Date":{"type":"timestamp"}, @@ -1396,21 +472,21 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityId" }, "DatasetName":{ "shape":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).", "location":"uri", - "locationName":"DatasetName", - "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + "locationName":"DatasetName" } }, "documentation":"A request to delete the specific dataset." @@ -1435,21 +511,21 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityId" }, "DatasetName":{ "shape":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).", "location":"uri", - "locationName":"DatasetName", - "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + "locationName":"DatasetName" } }, "documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name." @@ -1470,9 +546,9 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" } }, "documentation":"A request for usage information about the identity pool." @@ -1496,15 +572,15 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityId" } }, "documentation":"A request for information about the usage of an identity pool." @@ -1521,8 +597,8 @@ }, "DeviceId":{ "type":"string", - "min":1, - "max":256 + "max":256, + "min":1 }, "DuplicateRequestException":{ "type":"structure", @@ -1533,13 +609,9 @@ "documentation":"The message associated with the DuplicateRequestException exception." } }, - "error":{ - "code":"DuplicateRequest", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool." + "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool.", + "error":{"httpStatusCode":400}, + "exception":true }, "Events":{ "type":"map", @@ -1554,9 +626,9 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" } }, "documentation":"The input for the GetBulkPublishDetails operation." @@ -1593,9 +665,9 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"The Cognito Identity Pool ID for the request
", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"The Cognito Identity Pool ID for the request
" + "locationName":"IdentityPoolId" } }, "documentation":"A request for a list of the configured Cognito Events
" @@ -1616,9 +688,9 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.
", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.
" + "locationName":"IdentityPoolId" } }, "documentation":"The input for the GetIdentityPoolConfiguration operation.
" @@ -1643,14 +715,14 @@ }, "IdentityId":{ "type":"string", - "min":1, "max":55, + "min":1, "pattern":"[\\w-]+:[0-9a-f-]+" }, "IdentityPoolId":{ "type":"string", - "min":1, "max":55, + "min":1, "pattern":"[\\w-]+:[0-9a-f-]+" }, "IdentityPoolUsage":{ @@ -1716,13 +788,10 @@ "documentation":"Message returned by InternalErrorException." } }, - "error":{ - "code":"InternalError", - "httpStatusCode":500 - }, + "documentation":"Indicates an internal service error.", + "error":{"httpStatusCode":500}, "exception":true, - "fault":true, - "documentation":"Indicates an internal service error." + "fault":true }, "InvalidConfigurationException":{ "type":"structure", @@ -1733,11 +802,7 @@ "documentation":"Message returned by InvalidConfigurationException." } }, - "error":{ - "code":"InvalidConfiguration", - "httpStatusCode":400, - "senderFault":true - }, + "error":{"httpStatusCode":400}, "exception":true }, "InvalidLambdaFunctionOutputException":{ @@ -1749,13 +814,9 @@ "documentation":"A message returned when an InvalidLambdaFunctionOutputException occurs
" } }, - "error":{ - "code":"InvalidLambdaFunctionOutput", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"The AWS Lambda function returned invalid output or an exception.
" + "documentation":"The AWS Lambda function returned invalid output or an exception.
", + "error":{"httpStatusCode":400}, + "exception":true }, "InvalidParameterException":{ "type":"structure", @@ -1766,13 +827,9 @@ "documentation":"Message returned by InvalidParameterException." } }, - "error":{ - "code":"InvalidParameter", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a request parameter does not comply with the associated constraints." + "documentation":"Thrown when a request parameter does not comply with the associated constraints.", + "error":{"httpStatusCode":400}, + "exception":true }, "LambdaFunctionArn":{"type":"string"}, "LambdaThrottledException":{ @@ -1784,13 +841,9 @@ "documentation":"A message returned when an LambdaThrottledException is thrown
" } }, - "error":{ - "code":"LambdaThrottled", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"AWS Lambda throttled your account, please contact AWS Support
" + "documentation":"AWS Lambda throttled your account, please contact AWS Support
", + "error":{"httpStatusCode":429}, + "exception":true }, "LimitExceededException":{ "type":"structure", @@ -1801,13 +854,9 @@ "documentation":"Message returned by LimitExceededException." } }, - "error":{ - "code":"LimitExceeded", - "httpStatusCode":400, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." + "documentation":"Thrown when the limit on the number of objects or operations has been exceeded.", + "error":{"httpStatusCode":400}, + "exception":true }, "ListDatasetsRequest":{ "type":"structure", @@ -1818,27 +867,27 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityId" }, "NextToken":{ "shape":"String", + "documentation":"A pagination token for obtaining the next page of results.", "location":"querystring", - "locationName":"nextToken", - "documentation":"A pagination token for obtaining the next page of results." + "locationName":"nextToken" }, "MaxResults":{ "shape":"IntegerString", + "documentation":"The maximum number of results to be returned.", "location":"querystring", - "locationName":"maxResults", - "documentation":"The maximum number of results to be returned." + "locationName":"maxResults" } }, "documentation":"Request for a list of datasets for an identity." @@ -1866,15 +915,15 @@ "members":{ "NextToken":{ "shape":"String", + "documentation":"A pagination token for obtaining the next page of results.", "location":"querystring", - "locationName":"nextToken", - "documentation":"A pagination token for obtaining the next page of results." + "locationName":"nextToken" }, "MaxResults":{ "shape":"IntegerString", + "documentation":"The maximum number of results to be returned.", "location":"querystring", - "locationName":"maxResults", - "documentation":"The maximum number of results to be returned." + "locationName":"maxResults" } }, "documentation":"A request for usage information on an identity pool." @@ -1911,45 +960,45 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityId" }, "DatasetName":{ "shape":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).", "location":"uri", - "locationName":"DatasetName", - "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + "locationName":"DatasetName" }, "LastSyncCount":{ "shape":"Long", + "documentation":"The last server sync count for this record.", "location":"querystring", - "locationName":"lastSyncCount", - "documentation":"The last server sync count for this record." + "locationName":"lastSyncCount" }, "NextToken":{ "shape":"String", + "documentation":"A pagination token for obtaining the next page of results.", "location":"querystring", - "locationName":"nextToken", - "documentation":"A pagination token for obtaining the next page of results." + "locationName":"nextToken" }, "MaxResults":{ "shape":"IntegerString", + "documentation":"The maximum number of results to be returned.", "location":"querystring", - "locationName":"maxResults", - "documentation":"The maximum number of results to be returned." + "locationName":"maxResults" }, "SyncSessionToken":{ "shape":"SyncSessionToken", + "documentation":"A token containing a session ID, identity ID, and expiration.", "location":"querystring", - "locationName":"syncSessionToken", - "documentation":"A token containing a session ID, identity ID, and expiration." + "locationName":"syncSessionToken" } }, "documentation":"A request for a list of records." @@ -2010,13 +1059,9 @@ "documentation":"The message returned by a NotAuthorizedException." } }, - "error":{ - "code":"NotAuthorizedError", - "httpStatusCode":403, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown when a user is not authorized to access the requested resource." + "documentation":"Thrown when a user is not authorized to access the requested resource.", + "error":{"httpStatusCode":403}, + "exception":true }, "Operation":{ "type":"string", @@ -2081,8 +1126,8 @@ }, "RecordKey":{ "type":"string", - "min":1, - "max":1024 + "max":1024, + "min":1 }, "RecordList":{ "type":"list", @@ -2138,15 +1183,15 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.
", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.
" + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"The unique ID for this identity.
", "location":"uri", - "locationName":"IdentityId", - "documentation":"The unique ID for this identity.
" + "locationName":"IdentityId" }, "Platform":{ "shape":"Platform", @@ -2178,13 +1223,9 @@ "documentation":"The message returned by a ResourceConflictException." } }, - "error":{ - "code":"ResourceConflict", - "httpStatusCode":409, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." + "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict.", + "error":{"httpStatusCode":409}, + "exception":true }, "ResourceNotFoundException":{ "type":"structure", @@ -2195,13 +1236,9 @@ "documentation":"Message returned by a ResourceNotFoundException." } }, - "error":{ - "code":"ResourceNotFound", - "httpStatusCode":404, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the resource doesn't exist." + "documentation":"Thrown if the resource doesn't exist.", + "error":{"httpStatusCode":404}, + "exception":true }, "SetCognitoEventsRequest":{ "type":"structure", @@ -2212,9 +1249,9 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"The Cognito Identity Pool to use when configuring Cognito Events
", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"The Cognito Identity Pool to use when configuring Cognito Events
" + "locationName":"IdentityPoolId" }, "Events":{ "shape":"Events", @@ -2229,9 +1266,9 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.
", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.
" + "locationName":"IdentityPoolId" }, "PushSync":{ "shape":"PushSync", @@ -2264,8 +1301,8 @@ }, "StreamName":{ "type":"string", - "min":1, - "max":128 + "max":128, + "min":1 }, "StreamingStatus":{ "type":"string", @@ -2286,27 +1323,27 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.
", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.
" + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"Unique ID for this identity.
", "location":"uri", - "locationName":"IdentityId", - "documentation":"Unique ID for this identity.
" + "locationName":"IdentityId" }, "DatasetName":{ "shape":"DatasetName", + "documentation":"The name of the dataset to subcribe to.
", "location":"uri", - "locationName":"DatasetName", - "documentation":"The name of the dataset to subcribe to.
" + "locationName":"DatasetName" }, "DeviceId":{ "shape":"DeviceId", + "documentation":"The unique ID generated for this device by Cognito.
", "location":"uri", - "locationName":"DeviceId", - "documentation":"The unique ID generated for this device by Cognito.
" + "locationName":"DeviceId" } }, "documentation":"A request to SubscribeToDatasetRequest.
" @@ -2327,13 +1364,9 @@ "documentation":"Message returned by a TooManyRequestsException." } }, - "error":{ - "code":"TooManyRequests", - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "documentation":"Thrown if the request is throttled." + "documentation":"Thrown if the request is throttled.", + "error":{"httpStatusCode":429}, + "exception":true }, "UnsubscribeFromDatasetRequest":{ "type":"structure", @@ -2346,27 +1379,27 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.
", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.
" + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"Unique ID for this identity.
", "location":"uri", - "locationName":"IdentityId", - "documentation":"Unique ID for this identity.
" + "locationName":"IdentityId" }, "DatasetName":{ "shape":"DatasetName", + "documentation":"The name of the dataset from which to unsubcribe.
", "location":"uri", - "locationName":"DatasetName", - "documentation":"The name of the dataset from which to unsubcribe.
" + "locationName":"DatasetName" }, "DeviceId":{ "shape":"DeviceId", + "documentation":"The unique ID generated for this device by Cognito.
", "location":"uri", - "locationName":"DeviceId", - "documentation":"The unique ID generated for this device by Cognito.
" + "locationName":"DeviceId" } }, "documentation":"A request to UnsubscribeFromDataset.
" @@ -2388,21 +1421,21 @@ "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityPoolId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityPoolId" }, "IdentityId":{ "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.", "location":"uri", - "locationName":"IdentityId", - "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + "locationName":"IdentityId" }, "DatasetName":{ "shape":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).", "location":"uri", - "locationName":"DatasetName", - "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + "locationName":"DatasetName" }, "DeviceId":{ "shape":"DeviceId", @@ -2418,9 +1451,9 @@ }, "ClientContext":{ "shape":"ClientContext", + "documentation":"Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.", "location":"header", - "locationName":"x-amz-Client-Context", - "documentation":"Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented." + "locationName":"x-amz-Client-Context" } }, "documentation":"A request to post updates to records or add and delete records for a dataset and user." @@ -2436,6 +1469,5 @@ "documentation":"Returned for a successful UpdateRecordsRequest." } }, - "examples":{ - } + "documentation":"Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.
With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.
If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.
" } From 9dd44410195a6234472bc9cac525f5086a63671a Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:34 +0000 Subject: [PATCH 15/19] Amazon Comprehend Update: Support for customer managed KMS encryption of Comprehend custom models --- .../feature-AmazonComprehend-9c185bd.json | 6 +++++ .../codegen-resources/service-2.json | 24 +++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 .changes/next-release/feature-AmazonComprehend-9c185bd.json diff --git a/.changes/next-release/feature-AmazonComprehend-9c185bd.json b/.changes/next-release/feature-AmazonComprehend-9c185bd.json new file mode 100644 index 000000000000..b9347a6a2613 --- /dev/null +++ b/.changes/next-release/feature-AmazonComprehend-9c185bd.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Comprehend", + "contributor": "", + "description": "Support for customer managed KMS encryption of Comprehend custom models" +} diff --git a/services/comprehend/src/main/resources/codegen-resources/service-2.json b/services/comprehend/src/main/resources/codegen-resources/service-2.json index 5d57c10efe02..3745ff1bd626 100644 --- a/services/comprehend/src/main/resources/codegen-resources/service-2.json +++ b/services/comprehend/src/main/resources/codegen-resources/service-2.json @@ -1520,6 +1520,10 @@ "Mode":{ "shape":"DocumentClassifierMode", "documentation":"Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
" + }, + "ModelKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an endpoint to indicate its use by the sales department.
" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
" } } }, @@ -1613,6 +1621,10 @@ "VpcConfig":{ "shape":"VpcConfig", "documentation":"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
" + }, + "ModelKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
" + }, + "ModelKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Provides information about a document classifier.
" @@ -2452,6 +2468,10 @@ "LastModifiedTime":{ "shape":"Timestamp", "documentation":"The date and time that the endpoint was last modified.
" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
" } }, "documentation":"Specifies information about the specified endpoint.
" @@ -2814,6 +2834,10 @@ "VpcConfig":{ "shape":"VpcConfig", "documentation":"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
" + }, + "ModelKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Describes information about an entity recognizer.
" From 9f2d34b6f0a8b22702b36c4d8c01f71975e3f17d Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:32 +0000 Subject: [PATCH 16/19] Amazon Redshift Update: Enable customers to share access to their Redshift clusters from other VPCs (including VPCs from other accounts). --- .../feature-AmazonRedshift-6176455.json | 6 + .../codegen-resources/service-2.json | 545 +++++++++++++++++- 2 files changed, 550 insertions(+), 1 deletion(-) create mode 100644 .changes/next-release/feature-AmazonRedshift-6176455.json diff --git a/.changes/next-release/feature-AmazonRedshift-6176455.json b/.changes/next-release/feature-AmazonRedshift-6176455.json new file mode 100644 index 000000000000..1b5497e99ea6 --- /dev/null +++ b/.changes/next-release/feature-AmazonRedshift-6176455.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Redshift", + "contributor": "", + "description": "Enable customers to share access to their Redshift clusters from other VPCs (including VPCs from other accounts)." +} diff --git a/services/redshift/src/main/resources/codegen-resources/service-2.json b/services/redshift/src/main/resources/codegen-resources/service-2.json index 52059f5a9157..07298ac8e886 100644 --- a/services/redshift/src/main/resources/codegen-resources/service-2.json +++ b/services/redshift/src/main/resources/codegen-resources/service-2.json @@ -52,6 +52,27 @@ ], "documentation":"Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.
" }, + "AuthorizeEndpointAccess":{ + "name":"AuthorizeEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeEndpointAccessMessage"}, + "output":{ + "shape":"EndpointAuthorization", + "resultWrapper":"AuthorizeEndpointAccessResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"EndpointAuthorizationsPerClusterLimitExceededFault"}, + {"shape":"UnsupportedOperationFault"}, + {"shape":"EndpointAuthorizationAlreadyExistsFault"}, + {"shape":"InvalidAuthorizationStateFault"}, + {"shape":"InvalidClusterStateFault"} + ], + "documentation":"Grants access to a cluster.
" + }, "AuthorizeSnapshotAccess":{ "name":"AuthorizeSnapshotAccess", "http":{ @@ -265,6 +286,31 @@ ], "documentation":"Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.
" }, + "CreateEndpointAccess":{ + "name":"CreateEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEndpointAccessMessage"}, + "output":{ + "shape":"EndpointAccess", + "resultWrapper":"CreateEndpointAccessResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"AccessToClusterDeniedFault"}, + {"shape":"EndpointsPerClusterLimitExceededFault"}, + {"shape":"EndpointsPerAuthorizationLimitExceededFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"EndpointAlreadyExistsFault"}, + {"shape":"UnsupportedOperationFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"UnauthorizedOperation"} + ], + "documentation":"Creates a Redshift-managed VPC endpoint.
" + }, "CreateEventSubscription":{ "name":"CreateEventSubscription", "http":{ @@ -506,6 +552,26 @@ ], "documentation":"Deletes the specified cluster subnet group.
" }, + "DeleteEndpointAccess":{ + "name":"DeleteEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEndpointAccessMessage"}, + "output":{ + "shape":"EndpointAccess", + "resultWrapper":"DeleteEndpointAccessResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidEndpointStateFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"EndpointNotFoundFault"}, + {"shape":"InvalidClusterStateFault"} + ], + "documentation":"Deletes a Redshift-managed VPC endpoint.
" + }, "DeleteEventSubscription":{ "name":"DeleteEventSubscription", "http":{ @@ -785,6 +851,41 @@ }, "documentation":"Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
" }, + "DescribeEndpointAccess":{ + "name":"DescribeEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointAccessMessage"}, + "output":{ + "shape":"EndpointAccessList", + "resultWrapper":"DescribeEndpointAccessResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"EndpointNotFoundFault"} + ], + "documentation":"Describes a Redshift-managed VPC endpoint.
" + }, + "DescribeEndpointAuthorization":{ + "name":"DescribeEndpointAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointAuthorizationMessage"}, + "output":{ + "shape":"EndpointAuthorizationList", + "resultWrapper":"DescribeEndpointAuthorizationResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"Describes an endpoint authorization.
" + }, "DescribeEventCategories":{ "name":"DescribeEventCategories", "http":{ @@ -1348,6 +1449,27 @@ ], "documentation":"Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
" }, + "ModifyEndpointAccess":{ + "name":"ModifyEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEndpointAccessMessage"}, + "output":{ + "shape":"EndpointAccess", + "resultWrapper":"ModifyEndpointAccessResult" + }, + "errors":[ + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidEndpointStateFault"}, + {"shape":"EndpointNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"UnauthorizedOperation"} + ], + "documentation":"Modifies a Redshift-managed VPC endpoint.
" + }, "ModifyEventSubscription":{ "name":"ModifyEventSubscription", "http":{ @@ -1640,6 +1762,28 @@ ], "documentation":"Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.
" }, + "RevokeEndpointAccess":{ + "name":"RevokeEndpointAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeEndpointAccessMessage"}, + "output":{ + "shape":"EndpointAuthorization", + "resultWrapper":"RevokeEndpointAccessResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidEndpointStateFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"EndpointNotFoundFault"}, + {"shape":"EndpointAuthorizationNotFoundFault"}, + {"shape":"InvalidAuthorizationStateFault"}, + {"shape":"InvalidClusterStateFault"} + ], + "documentation":"Revokes access to a cluster.
" + }, "RevokeSnapshotAccess":{ "name":"RevokeSnapshotAccess", "http":{ @@ -1704,6 +1848,18 @@ } } }, + "AccessToClusterDeniedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"You are not authorized to access the cluster.
", + "error":{ + "code":"AccessToClusterDenied", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "AccessToSnapshotDeniedFault":{ "type":"structure", "members":{ @@ -1842,6 +1998,13 @@ }, "exception":true }, + "AuthorizationStatus":{ + "type":"string", + "enum":[ + "Authorized", + "Revoking" + ] + }, "AuthorizeClusterSecurityGroupIngressMessage":{ "type":"structure", "required":["ClusterSecurityGroupName"], @@ -1871,6 +2034,24 @@ "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} } }, + "AuthorizeEndpointAccessMessage":{ + "type":"structure", + "required":["Account"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The cluster identifier of the cluster to grant access to.
" + }, + "Account":{ + "shape":"String", + "documentation":"The AWS account ID to grant access to.
" + }, + "VpcIds":{ + "shape":"VpcIdentifierList", + "documentation":"The virtual private cloud (VPC) identifiers to grant access to.
" + } + } + }, "AuthorizeSnapshotAccessMessage":{ "type":"structure", "required":[ @@ -3195,6 +3376,35 @@ "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} } }, + "CreateEndpointAccessMessage":{ + "type":"structure", + "required":[ + "EndpointName", + "SubnetGroupName" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The cluster identifier of the cluster to access.
" + }, + "ResourceOwner":{ + "shape":"String", + "documentation":"The AWS account ID of the owner of the cluster. This is only required if the cluster is in another AWS account.
" + }, + "EndpointName":{ + "shape":"String", + "documentation":"The Redshift-managed VPC endpoint name.
An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
" + }, + "SubnetGroupName":{ + "shape":"String", + "documentation":"The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
" + } + } + }, "CreateEventSubscriptionMessage":{ "type":"structure", "required":[ @@ -3650,6 +3860,16 @@ }, "documentation":"" }, + "DeleteEndpointAccessMessage":{ + "type":"structure", + "required":["EndpointName"], + "members":{ + "EndpointName":{ + "shape":"String", + "documentation":"The Redshift-managed VPC endpoint to delete.
" + } + } + }, "DeleteEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], @@ -4037,6 +4257,60 @@ "DefaultClusterParameters":{"shape":"DefaultClusterParameters"} } }, + "DescribeEndpointAccessMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The cluster identifier associated with the described endpoint.
" + }, + "ResourceOwner":{ + "shape":"String", + "documentation":"The AWS account ID of the owner of the cluster.
" + }, + "EndpointName":{ + "shape":"String", + "documentation":"The name of the endpoint to be described.
" + }, + "VpcId":{ + "shape":"String", + "documentation":"The virtual private cloud (VPC) identifier with access to the cluster.
" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"Reserved for Amazon Redshift internal use.
" + }, + "Marker":{ + "shape":"String", + "documentation":"Reserved for Amazon Redshift internal use.
" + } + } + }, + "DescribeEndpointAuthorizationMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The cluster identifier of the cluster to access.
" + }, + "Account":{ + "shape":"String", + "documentation":"The AWS account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.
Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view.
" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"Reserved for Amazon Redshift internal use.
" + }, + "Marker":{ + "shape":"String", + "documentation":"Reserved for Amazon Redshift internal use.
" + } + } + }, "DescribeEventCategoriesMessage":{ "type":"structure", "members":{ @@ -4620,6 +4894,209 @@ }, "documentation":"Describes a connection endpoint.
" }, + "EndpointAccess":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The cluster identifier of the cluster associated with the endpoint.
" + }, + "ResourceOwner":{ + "shape":"String", + "documentation":"The AWS account ID of the owner of the cluster.
" + }, + "SubnetGroupName":{ + "shape":"String", + "documentation":"The subnet group name where Amazon Redshift chooses to deploy the endpoint.
" + }, + "EndpointStatus":{ + "shape":"String", + "documentation":"The status of the endpoint.
" + }, + "EndpointName":{ + "shape":"String", + "documentation":"The name of the endpoint.
" + }, + "EndpointCreateTime":{ + "shape":"TStamp", + "documentation":"The time (UTC) that the endpoint was created.
" + }, + "Port":{ + "shape":"Integer", + "documentation":"The port number on which the cluster accepts incoming connections.
" + }, + "Address":{ + "shape":"String", + "documentation":"The DNS address of the endpoint.
" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"The security groups associated with the endpoint.
" + }, + "VpcEndpoint":{"shape":"VpcEndpoint"} + }, + "documentation":"Describes a Redshift-managed VPC endpoint.
" + }, + "EndpointAccessList":{ + "type":"structure", + "members":{ + "EndpointAccessList":{ + "shape":"EndpointAccesses", + "documentation":"The list of endpoints with access to the cluster.
" + }, + "Marker":{ + "shape":"String", + "documentation":"Reserved for Amazon Redshift internal use.
" + } + } + }, + "EndpointAccesses":{ + "type":"list", + "member":{"shape":"EndpointAccess"} + }, + "EndpointAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The account already has a Redshift-managed VPC endpoint with the given identifier.
", + "error":{ + "code":"EndpointAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EndpointAuthorization":{ + "type":"structure", + "members":{ + "Grantor":{ + "shape":"String", + "documentation":"The AWS account ID of the cluster owner.
" + }, + "Grantee":{ + "shape":"String", + "documentation":"The AWS account ID of the grantee of the cluster.
" + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The cluster identifier.
" + }, + "AuthorizeTime":{ + "shape":"TStamp", + "documentation":"The time (UTC) when the authorization was created.
" + }, + "ClusterStatus":{ + "shape":"String", + "documentation":"The status of the cluster.
" + }, + "Status":{ + "shape":"AuthorizationStatus", + "documentation":"The status of the authorization action.
" + }, + "AllowedAllVPCs":{ + "shape":"Boolean", + "documentation":"Indicates whether all VPCs in the grantee account are allowed access to the cluster.
" + }, + "AllowedVPCs":{ + "shape":"VpcIdentifierList", + "documentation":"The VPCs allowed access to the cluster.
" + }, + "EndpointCount":{ + "shape":"Integer", + "documentation":"The number of Redshift-managed VPC endpoints created for the authorization.
" + } + }, + "documentation":"Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.
" + }, + "EndpointAuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The authorization already exists for this endpoint.
", + "error":{ + "code":"EndpointAuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EndpointAuthorizationList":{ + "type":"structure", + "members":{ + "EndpointAuthorizationList":{ + "shape":"EndpointAuthorizations", + "documentation":"The authorizations to an endpoint.
" + }, + "Marker":{ + "shape":"String", + "documentation":"Reserved for Amazon Redshift internal use.
" + } + } + }, + "EndpointAuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The authorization for this endpoint can't be found.
", + "error":{ + "code":"EndpointAuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "EndpointAuthorizations":{ + "type":"list", + "member":{"shape":"EndpointAuthorization"} + }, + "EndpointAuthorizationsPerClusterLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The number of endpoint authorizations per cluster has exceeded its limit.
", + "error":{ + "code":"EndpointAuthorizationsPerClusterLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EndpointNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The endpoint name doesn't refer to an existing endpoint.
", + "error":{ + "code":"EndpointNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "EndpointsPerAuthorizationLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.
", + "error":{ + "code":"EndpointsPerAuthorizationLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EndpointsPerClusterLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.
", + "error":{ + "code":"EndpointsPerClusterLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "Event":{ "type":"structure", "members":{ @@ -5166,6 +5643,18 @@ }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, + "InvalidAuthorizationStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The status of the authorization is not valid.
", + "error":{ + "code":"InvalidAuthorizationState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidClusterParameterGroupStateFault":{ "type":"structure", "members":{ @@ -5274,6 +5763,18 @@ }, "exception":true }, + "InvalidEndpointStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"The status of the endpoint is not valid.
", + "error":{ + "code":"InvalidEndpointState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidHsmClientCertificateStateFault":{ "type":"structure", "members":{ @@ -5820,6 +6321,20 @@ "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} } }, + "ModifyEndpointAccessMessage":{ + "type":"structure", + "required":["EndpointName"], + "members":{ + "EndpointName":{ + "shape":"String", + "documentation":"The endpoint to be modified.
" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"The complete list of VPC security groups associated with the endpoint after the endpoint is modified.
" + } + } + }, "ModifyEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], @@ -6996,6 +7511,27 @@ "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} } }, + "RevokeEndpointAccessMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"The cluster to revoke access from.
" + }, + "Account":{ + "shape":"String", + "documentation":"The AWS account ID whose access is to be revoked.
" + }, + "VpcIds":{ + "shape":"VpcIdentifierList", + "documentation":"The virtual private cloud (VPC) identifiers for which access is to be revoked.
" + }, + "Force":{ + "shape":"Boolean", + "documentation":"Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
" + } + } + }, "RevokeSnapshotAccessMessage":{ "type":"structure", "required":[ @@ -8323,7 +8859,7 @@ "documentation":"One or more network interfaces of the endpoint. Also known as an interface endpoint.
" } }, - "documentation":"The connection endpoint for connecting an Amazon Redshift cluster through the proxy.
" + "documentation":"The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
" }, "VpcEndpointsList":{ "type":"list", @@ -8332,6 +8868,13 @@ "locationName":"VpcEndpoint" } }, + "VpcIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcIdentifier" + } + }, "VpcSecurityGroupIdList":{ "type":"list", "member":{ From 4a83bea68c175a57f9fae7ab276bdbdc9a69ca38 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:06:52 +0000 Subject: [PATCH 17/19] AWS Direct Connect Update: This release adds MACsec support to AWS Direct Connect --- .../feature-AWSDirectConnect-681117c.json | 6 + .../codegen-resources/service-2.json | 210 +++++++++++++++++- 2 files changed, 215 insertions(+), 1 deletion(-) create mode 100644 .changes/next-release/feature-AWSDirectConnect-681117c.json diff --git a/.changes/next-release/feature-AWSDirectConnect-681117c.json b/.changes/next-release/feature-AWSDirectConnect-681117c.json new file mode 100644 index 000000000000..80f886ca56cf --- /dev/null +++ b/.changes/next-release/feature-AWSDirectConnect-681117c.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Direct Connect", + "contributor": "", + "description": "This release adds MACsec support to AWS Direct Connect" +} diff --git a/services/directconnect/src/main/resources/codegen-resources/service-2.json b/services/directconnect/src/main/resources/codegen-resources/service-2.json index fb8fcfa0594e..ab20ed2aa1af 100644 --- a/services/directconnect/src/main/resources/codegen-resources/service-2.json +++ b/services/directconnect/src/main/resources/codegen-resources/service-2.json @@ -133,6 +133,20 @@ ], "documentation":"Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.
Intended for use by AWS Direct Connect Partners only.
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an AWS Direct Connect dedicated connection.
You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the AWS Direct Connect User Guide.
" + }, "AssociateVirtualInterface":{ "name":"AssociateVirtualInterface", "http":{ @@ -706,6 +720,20 @@ ], "documentation":"Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect.
If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
" }, + "DisassociateMacSecKey":{ + "name":"DisassociateMacSecKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateMacSecKeyRequest"}, + "output":{"shape":"DisassociateMacSecKeyResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.
" + }, "ListVirtualInterfaceTestHistory":{ "name":"ListVirtualInterfaceTestHistory", "http":{ @@ -778,6 +806,20 @@ ], "documentation":"Removes one or more tags from the specified AWS Direct Connect resource.
" }, + "UpdateConnection":{ + "name":"UpdateConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConnectionRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"Updates the AWS Direct Connect dedicated connection configuration.
You can update the following parameters for a connection:
The connection name
The connection's MAC Security (MACsec) encryption mode.
Updates the attributes of the specified link aggregation group (LAG).
You can update the following attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections.
" + "documentation":"Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
The name of the LAG.
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
The LAG's MACsec encryption mode.
AWS assigns this value to each connection which is part of the LAG.
The tags
If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
You can use DescribeConnections or DescribeLags to retrieve connection ID.
" + }, + "secretARN":{ + "shape":"SecretARN", + "documentation":"The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.
You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.
If you use this request parameter, you do not use the ckn and cak request parameters.
The MAC Security (MACsec) CKN to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.
The MAC Security (MACsec) CAK to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
" + }, + "macSecKeys":{ + "shape":"MacSecKeyList", + "documentation":"The MAC Security (MACsec) security keys associated with the dedicated connection.
" + } + } + }, "AssociateVirtualInterfaceRequest":{ "type":"structure", "required":[ @@ -1077,6 +1154,10 @@ "documentation":"Information about the associated gateway.
" }, "AssociatedGatewayId":{"type":"string"}, + "AvailableMacSecPortSpeeds":{ + "type":"list", + "member":{"shape":"PortSpeed"} + }, "AvailablePortSpeeds":{ "type":"list", "member":{"shape":"PortSpeed"} @@ -1159,6 +1240,8 @@ "Bandwidth":{"type":"string"}, "BooleanFlag":{"type":"boolean"}, "CIDR":{"type":"string"}, + "Cak":{"type":"string"}, + "Ckn":{"type":"string"}, "ConfirmConnectionRequest":{ "type":"structure", "required":["connectionId"], @@ -1320,6 +1403,22 @@ "providerName":{ "shape":"ProviderName", "documentation":"The name of the service provider associated with the connection.
" + }, + "macSecCapable":{ + "shape":"MacSecCapable", + "documentation":"Indicates whether the connection supports MAC Security (MACsec).
" + }, + "portEncryptionStatus":{ + "shape":"PortEncryptionStatus", + "documentation":"The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
The MAC Security (MACsec) security keys associated with the connection.
" } }, "documentation":"Information about an AWS Direct Connect connection.
" @@ -1407,6 +1506,10 @@ "providerName":{ "shape":"ProviderName", "documentation":"The name of the service provider associated with the requested connection.
" + }, + "requestMACSec":{ + "shape":"RequestMACSec", + "documentation":"Indicates whether you want the connection to support MAC Security (MACsec).
MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide.
" } } }, @@ -1577,6 +1680,10 @@ "providerName":{ "shape":"ProviderName", "documentation":"The name of the service provider associated with the LAG.
" + }, + "requestMACSec":{ + "shape":"RequestMACSec", + "documentation":"Indicates whether the connection will support MAC Security (MACsec).
All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide.
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
You can use DescribeConnections or DescribeLags to retrieve connection ID.
" + }, + "secretARN":{ + "shape":"SecretARN", + "documentation":"The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.
" + } + } + }, + "DisassociateMacSecKeyResponse":{ + "type":"structure", + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
" + }, + "macSecKeys":{ + "shape":"MacSecKeyList", + "documentation":"The MAC Security (MACsec) security keys no longer associated with the dedicated connection.
" + } + } + }, "DuplicateTagKeysException":{ "type":"structure", "members":{ @@ -2332,6 +2469,7 @@ "documentation":"A tag key was specified more than once.
", "exception":true }, + "EncryptionMode":{"type":"string"}, "EndTime":{"type":"timestamp"}, "ErrorMessage":{"type":"string"}, "FailureTestHistoryStatus":{"type":"string"}, @@ -2512,6 +2650,18 @@ "providerName":{ "shape":"ProviderName", "documentation":"The name of the service provider associated with the LAG.
" + }, + "macSecCapable":{ + "shape":"MacSecCapable", + "documentation":"Indicates whether the LAG supports MAC Security (MACsec).
" + }, + "encryptionMode":{ + "shape":"EncryptionMode", + "documentation":"The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
The MAC Security (MACsec) security keys associated with the LAG.
" } }, "documentation":"Information about a link aggregation group (LAG).
" @@ -2627,6 +2777,10 @@ "availableProviders":{ "shape":"ProviderList", "documentation":"The name of the service provider for the location.
" + }, + "availableMacSecPortSpeeds":{ + "shape":"AvailableMacSecPortSpeeds", + "documentation":"The available MAC Security (MACsec) port speeds for the location.
" } }, "documentation":"Information about an AWS Direct Connect location.
" @@ -2648,6 +2802,33 @@ }, "LongAsn":{"type":"long"}, "MTU":{"type":"integer"}, + "MacSecCapable":{"type":"boolean"}, + "MacSecKey":{ + "type":"structure", + "members":{ + "secretARN":{ + "shape":"SecretARN", + "documentation":"The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
" + }, + "ckn":{ + "shape":"Ckn", + "documentation":"The Connection Key Name (CKN) for the MAC Security secret key.
" + }, + "state":{ + "shape":"State", + "documentation":"The state of the MAC Security (MACsec) secret key.
The possible values are:
associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
" + } + }, + "documentation":"Information about the MAC Security (MACsec) secret key.
" + }, + "MacSecKeyList":{ + "type":"list", + "member":{"shape":"MacSecKey"} + }, "MaxResultSetSize":{ "type":"integer", "box":true @@ -2965,6 +3146,7 @@ "OwnerAccount":{"type":"string"}, "PaginationToken":{"type":"string"}, "PartnerName":{"type":"string"}, + "PortEncryptionStatus":{"type":"string"}, "PortSpeed":{"type":"string"}, "ProviderList":{ "type":"list", @@ -2972,6 +3154,7 @@ }, "ProviderName":{"type":"string"}, "Region":{"type":"string"}, + "RequestMACSec":{"type":"boolean"}, "ResourceArn":{"type":"string"}, "ResourceArnList":{ "type":"list", @@ -3010,6 +3193,7 @@ "member":{"shape":"RouteFilterPrefix"} }, "RouterConfig":{"type":"string"}, + "SecretARN":{"type":"string"}, "StartBgpFailoverTestRequest":{ "type":"structure", "required":["virtualInterfaceId"], @@ -3037,7 +3221,9 @@ } } }, + "StartOnDate":{"type":"string"}, "StartTime":{"type":"timestamp"}, + "State":{"type":"string"}, "StateChangeError":{"type":"string"}, "StopBgpFailoverTestRequest":{ "type":"structure", @@ -3150,6 +3336,24 @@ "members":{ } }, + "UpdateConnectionRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"The ID of the dedicated connection.
You can use DescribeConnections to retrieve the connection ID.
" + }, + "connectionName":{ + "shape":"ConnectionName", + "documentation":"The name of the connection.
" + }, + "encryptionMode":{ + "shape":"EncryptionMode", + "documentation":"The connection MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
The minimum number of physical connections that must be operational for the LAG itself to be operational.
" + }, + "encryptionMode":{ + "shape":"EncryptionMode", + "documentation":"The LAG MAC Security (MACsec) encryption mode.
AWS applies the value to all connections which are part of the LAG.
" } } }, From 95b9319b5cc7bbb93ebea0f493305eb12d6e0638 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:07:45 +0000 Subject: [PATCH 18/19] Updated endpoints.json. --- .../feature-AWSSDKforJavav2-bedacd4.json | 6 ++++++ .../awssdk/regions/internal/region/endpoints.json | 13 ++++++++++--- 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 .changes/next-release/feature-AWSSDKforJavav2-bedacd4.json diff --git a/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json b/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json new file mode 100644 index 000000000000..ae3f84993e9e --- /dev/null +++ b/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS SDK for Java v2", + "contributor": "", + "description": "Updated service endpoint metadata." +} diff --git a/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json b/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json index 0073433e8648..afc2cd0363ff 100644 --- a/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json +++ b/core/regions/src/main/resources/software/amazon/awssdk/regions/internal/region/endpoints.json @@ -6157,9 +6157,7 @@ }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { - "sslCommonName" : "queue.{dnsSuffix}" - }, + "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, "us-west-2" : { } @@ -9238,6 +9236,15 @@ } } }, + "servicequotas" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "sms" : { "endpoints" : { "fips-us-gov-east-1" : { From 44971636fcdf816362f78b23e86d5efe61268e32 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 31 Mar 2021 18:08:31 +0000 Subject: [PATCH 19/19] Release 2.16.32. Updated CHANGELOG.md, README.md and all pom.xml. --- .changes/2.16.32.json | 108 ++++++++++++++++++ .../feature-AWSBatch-a5021fe.json | 6 - .../feature-AWSCloud9-6460db9.json | 6 - .../feature-AWSCloudFormation-ce57026.json | 6 - .../feature-AWSDataPipeline-23bdeb0.json | 6 - .../feature-AWSDirectConnect-681117c.json | 6 - .../next-release/feature-AWSIoT-eceaf2a.json | 6 - .../feature-AWSIoTWireless-bdb5648.json | 6 - .../feature-AWSPriceListService-d9d8643.json | 6 - .../feature-AWSSDKforJavav2-bedacd4.json | 6 - .../feature-AmazonCloudHSM-5749bc7.json | 6 - .../feature-AmazonCognitoSync-ab91ead.json | 6 - .../feature-AmazonComprehend-9c185bd.json | 6 - .../feature-AmazonDetective-283b026.json | 6 - ...feature-AmazonMachineLearning-4673b6f.json | 6 - .../feature-AmazonRedshift-6176455.json | 6 - ...ature-AmazonTranscribeService-63ec310.json | 6 - .../feature-AmazonWorkMail-767e9b2.json | 6 - CHANGELOG.md | 69 +++++++++++ README.md | 8 +- archetypes/archetype-app-quickstart/pom.xml | 2 +- archetypes/archetype-lambda/pom.xml | 2 +- archetypes/archetype-tools/pom.xml | 2 +- archetypes/pom.xml | 2 +- aws-sdk-java/pom.xml | 2 +- bom-internal/pom.xml | 2 +- bom/pom.xml | 2 +- bundle/pom.xml | 2 +- codegen-lite-maven-plugin/pom.xml | 2 +- codegen-lite/pom.xml | 2 +- codegen-maven-plugin/pom.xml | 2 +- codegen/pom.xml | 2 +- core/annotations/pom.xml | 2 +- core/arns/pom.xml | 2 +- core/auth/pom.xml | 2 +- core/aws-core/pom.xml | 2 +- core/metrics-spi/pom.xml | 2 +- core/pom.xml | 2 +- core/profiles/pom.xml | 2 +- core/protocols/aws-cbor-protocol/pom.xml | 2 +- core/protocols/aws-ion-protocol/pom.xml | 2 +- core/protocols/aws-json-protocol/pom.xml | 2 +- core/protocols/aws-query-protocol/pom.xml | 2 +- core/protocols/aws-xml-protocol/pom.xml | 2 +- core/protocols/pom.xml | 2 +- core/protocols/protocol-core/pom.xml | 2 +- core/regions/pom.xml | 2 +- core/sdk-core/pom.xml | 2 +- http-client-spi/pom.xml | 2 +- http-clients/apache-client/pom.xml | 2 +- http-clients/aws-crt-client/pom.xml | 2 +- http-clients/netty-nio-client/pom.xml | 2 +- http-clients/pom.xml | 2 +- http-clients/url-connection-client/pom.xml | 2 +- .../cloudwatch-metric-publisher/pom.xml | 2 +- metric-publishers/pom.xml | 2 +- pom.xml | 2 +- release-scripts/pom.xml | 2 +- services-custom/dynamodb-enhanced/pom.xml | 2 +- services-custom/pom.xml | 2 +- services/accessanalyzer/pom.xml | 2 +- services/acm/pom.xml | 2 +- services/acmpca/pom.xml | 2 +- services/alexaforbusiness/pom.xml | 2 +- services/amp/pom.xml | 2 +- services/amplify/pom.xml | 2 +- services/amplifybackend/pom.xml | 2 +- services/apigateway/pom.xml | 2 +- services/apigatewaymanagementapi/pom.xml | 2 +- services/apigatewayv2/pom.xml | 2 +- services/appconfig/pom.xml | 2 +- services/appflow/pom.xml | 2 +- services/appintegrations/pom.xml | 2 +- services/applicationautoscaling/pom.xml | 2 +- services/applicationdiscovery/pom.xml | 2 +- services/applicationinsights/pom.xml | 2 +- services/appmesh/pom.xml | 2 +- services/appstream/pom.xml | 2 +- services/appsync/pom.xml | 2 +- services/athena/pom.xml | 2 +- services/auditmanager/pom.xml | 2 +- services/autoscaling/pom.xml | 2 +- services/autoscalingplans/pom.xml | 2 +- services/backup/pom.xml | 2 +- services/batch/pom.xml | 2 +- services/braket/pom.xml | 2 +- services/budgets/pom.xml | 2 +- services/chime/pom.xml | 2 +- services/cloud9/pom.xml | 2 +- services/clouddirectory/pom.xml | 2 +- services/cloudformation/pom.xml | 2 +- services/cloudfront/pom.xml | 2 +- services/cloudhsm/pom.xml | 2 +- services/cloudhsmv2/pom.xml | 2 +- services/cloudsearch/pom.xml | 2 +- services/cloudsearchdomain/pom.xml | 2 +- services/cloudtrail/pom.xml | 2 +- services/cloudwatch/pom.xml | 2 +- services/cloudwatchevents/pom.xml | 2 +- services/cloudwatchlogs/pom.xml | 2 +- services/codeartifact/pom.xml | 2 +- services/codebuild/pom.xml | 2 +- services/codecommit/pom.xml | 2 +- services/codedeploy/pom.xml | 2 +- services/codeguruprofiler/pom.xml | 2 +- services/codegurureviewer/pom.xml | 2 +- services/codepipeline/pom.xml | 2 +- services/codestar/pom.xml | 2 +- services/codestarconnections/pom.xml | 2 +- services/codestarnotifications/pom.xml | 2 +- services/cognitoidentity/pom.xml | 2 +- services/cognitoidentityprovider/pom.xml | 2 +- services/cognitosync/pom.xml | 2 +- services/comprehend/pom.xml | 2 +- services/comprehendmedical/pom.xml | 2 +- services/computeoptimizer/pom.xml | 2 +- services/config/pom.xml | 2 +- services/connect/pom.xml | 2 +- services/connectcontactlens/pom.xml | 2 +- services/connectparticipant/pom.xml | 2 +- services/costandusagereport/pom.xml | 2 +- services/costexplorer/pom.xml | 2 +- services/customerprofiles/pom.xml | 2 +- services/databasemigration/pom.xml | 2 +- services/databrew/pom.xml | 2 +- services/dataexchange/pom.xml | 2 +- services/datapipeline/pom.xml | 2 +- services/datasync/pom.xml | 2 +- services/dax/pom.xml | 2 +- services/detective/pom.xml | 2 +- services/devicefarm/pom.xml | 2 +- services/devopsguru/pom.xml | 2 +- services/directconnect/pom.xml | 2 +- services/directory/pom.xml | 2 +- services/dlm/pom.xml | 2 +- services/docdb/pom.xml | 2 +- services/dynamodb/pom.xml | 2 +- services/ebs/pom.xml | 2 +- services/ec2/pom.xml | 2 +- services/ec2instanceconnect/pom.xml | 2 +- services/ecr/pom.xml | 2 +- services/ecrpublic/pom.xml | 2 +- services/ecs/pom.xml | 2 +- services/efs/pom.xml | 2 +- services/eks/pom.xml | 2 +- services/elasticache/pom.xml | 2 +- services/elasticbeanstalk/pom.xml | 2 +- services/elasticinference/pom.xml | 2 +- services/elasticloadbalancing/pom.xml | 2 +- services/elasticloadbalancingv2/pom.xml | 2 +- services/elasticsearch/pom.xml | 2 +- services/elastictranscoder/pom.xml | 2 +- services/emr/pom.xml | 2 +- services/emrcontainers/pom.xml | 2 +- services/eventbridge/pom.xml | 2 +- services/firehose/pom.xml | 2 +- services/fis/pom.xml | 2 +- services/fms/pom.xml | 2 +- services/forecast/pom.xml | 2 +- services/forecastquery/pom.xml | 2 +- services/frauddetector/pom.xml | 2 +- services/fsx/pom.xml | 2 +- services/gamelift/pom.xml | 2 +- services/glacier/pom.xml | 2 +- services/globalaccelerator/pom.xml | 2 +- services/glue/pom.xml | 2 +- services/greengrass/pom.xml | 2 +- services/greengrassv2/pom.xml | 2 +- services/groundstation/pom.xml | 2 +- services/guardduty/pom.xml | 2 +- services/health/pom.xml | 2 +- services/healthlake/pom.xml | 2 +- services/honeycode/pom.xml | 2 +- services/iam/pom.xml | 2 +- services/identitystore/pom.xml | 2 +- services/imagebuilder/pom.xml | 2 +- services/inspector/pom.xml | 2 +- services/iot/pom.xml | 2 +- services/iot1clickdevices/pom.xml | 2 +- services/iot1clickprojects/pom.xml | 2 +- services/iotanalytics/pom.xml | 2 +- services/iotdataplane/pom.xml | 2 +- services/iotdeviceadvisor/pom.xml | 2 +- services/iotevents/pom.xml | 2 +- services/ioteventsdata/pom.xml | 2 +- services/iotfleethub/pom.xml | 2 +- services/iotjobsdataplane/pom.xml | 2 +- services/iotsecuretunneling/pom.xml | 2 +- services/iotsitewise/pom.xml | 2 +- services/iotthingsgraph/pom.xml | 2 +- services/iotwireless/pom.xml | 2 +- services/ivs/pom.xml | 2 +- services/kafka/pom.xml | 2 +- services/kendra/pom.xml | 2 +- services/kinesis/pom.xml | 2 +- services/kinesisanalytics/pom.xml | 2 +- services/kinesisanalyticsv2/pom.xml | 2 +- services/kinesisvideo/pom.xml | 2 +- services/kinesisvideoarchivedmedia/pom.xml | 2 +- services/kinesisvideomedia/pom.xml | 2 +- services/kinesisvideosignaling/pom.xml | 2 +- services/kms/pom.xml | 2 +- services/lakeformation/pom.xml | 2 +- services/lambda/pom.xml | 2 +- services/lexmodelbuilding/pom.xml | 2 +- services/lexmodelsv2/pom.xml | 2 +- services/lexruntime/pom.xml | 2 +- services/lexruntimev2/pom.xml | 2 +- services/licensemanager/pom.xml | 2 +- services/lightsail/pom.xml | 2 +- services/location/pom.xml | 2 +- services/lookoutmetrics/pom.xml | 2 +- services/lookoutvision/pom.xml | 2 +- services/machinelearning/pom.xml | 2 +- services/macie/pom.xml | 2 +- services/macie2/pom.xml | 2 +- services/managedblockchain/pom.xml | 2 +- services/marketplacecatalog/pom.xml | 2 +- services/marketplacecommerceanalytics/pom.xml | 2 +- services/marketplaceentitlement/pom.xml | 2 +- services/marketplacemetering/pom.xml | 2 +- services/mediaconnect/pom.xml | 2 +- services/mediaconvert/pom.xml | 2 +- services/medialive/pom.xml | 2 +- services/mediapackage/pom.xml | 2 +- services/mediapackagevod/pom.xml | 2 +- services/mediastore/pom.xml | 2 +- services/mediastoredata/pom.xml | 2 +- services/mediatailor/pom.xml | 2 +- services/migrationhub/pom.xml | 2 +- services/migrationhubconfig/pom.xml | 2 +- services/mobile/pom.xml | 2 +- services/mq/pom.xml | 2 +- services/mturk/pom.xml | 2 +- services/mwaa/pom.xml | 2 +- services/neptune/pom.xml | 2 +- services/networkfirewall/pom.xml | 2 +- services/networkmanager/pom.xml | 2 +- services/opsworks/pom.xml | 2 +- services/opsworkscm/pom.xml | 2 +- services/organizations/pom.xml | 2 +- services/outposts/pom.xml | 2 +- services/personalize/pom.xml | 2 +- services/personalizeevents/pom.xml | 2 +- services/personalizeruntime/pom.xml | 2 +- services/pi/pom.xml | 2 +- services/pinpoint/pom.xml | 2 +- services/pinpointemail/pom.xml | 2 +- services/pinpointsmsvoice/pom.xml | 2 +- services/polly/pom.xml | 2 +- services/pom.xml | 2 +- services/pricing/pom.xml | 2 +- services/qldb/pom.xml | 2 +- services/qldbsession/pom.xml | 2 +- services/quicksight/pom.xml | 2 +- services/ram/pom.xml | 2 +- services/rds/pom.xml | 2 +- services/rdsdata/pom.xml | 2 +- services/redshift/pom.xml | 2 +- services/redshiftdata/pom.xml | 2 +- services/rekognition/pom.xml | 2 +- services/resourcegroups/pom.xml | 2 +- services/resourcegroupstaggingapi/pom.xml | 2 +- services/robomaker/pom.xml | 2 +- services/route53/pom.xml | 2 +- services/route53domains/pom.xml | 2 +- services/route53resolver/pom.xml | 2 +- services/s3/pom.xml | 2 +- services/s3control/pom.xml | 2 +- services/s3outposts/pom.xml | 2 +- services/sagemaker/pom.xml | 2 +- services/sagemakera2iruntime/pom.xml | 2 +- services/sagemakeredge/pom.xml | 2 +- services/sagemakerfeaturestoreruntime/pom.xml | 2 +- services/sagemakerruntime/pom.xml | 2 +- services/savingsplans/pom.xml | 2 +- services/schemas/pom.xml | 2 +- services/secretsmanager/pom.xml | 2 +- services/securityhub/pom.xml | 2 +- .../serverlessapplicationrepository/pom.xml | 2 +- services/servicecatalog/pom.xml | 2 +- services/servicecatalogappregistry/pom.xml | 2 +- services/servicediscovery/pom.xml | 2 +- services/servicequotas/pom.xml | 2 +- services/ses/pom.xml | 2 +- services/sesv2/pom.xml | 2 +- services/sfn/pom.xml | 2 +- services/shield/pom.xml | 2 +- services/signer/pom.xml | 2 +- services/sms/pom.xml | 2 +- services/snowball/pom.xml | 2 +- services/sns/pom.xml | 2 +- services/sqs/pom.xml | 2 +- services/ssm/pom.xml | 2 +- services/sso/pom.xml | 2 +- services/ssoadmin/pom.xml | 2 +- services/ssooidc/pom.xml | 2 +- services/storagegateway/pom.xml | 2 +- services/sts/pom.xml | 2 +- services/support/pom.xml | 2 +- services/swf/pom.xml | 2 +- services/synthetics/pom.xml | 2 +- services/textract/pom.xml | 2 +- services/timestreamquery/pom.xml | 2 +- services/timestreamwrite/pom.xml | 2 +- services/transcribe/pom.xml | 2 +- services/transcribestreaming/pom.xml | 2 +- services/transfer/pom.xml | 2 +- services/translate/pom.xml | 2 +- services/waf/pom.xml | 2 +- services/wafv2/pom.xml | 2 +- services/wellarchitected/pom.xml | 2 +- services/workdocs/pom.xml | 2 +- services/worklink/pom.xml | 2 +- services/workmail/pom.xml | 2 +- services/workmailmessageflow/pom.xml | 2 +- services/workspaces/pom.xml | 2 +- services/xray/pom.xml | 2 +- test/codegen-generated-classes-test/pom.xml | 2 +- test/http-client-tests/pom.xml | 2 +- test/module-path-tests/pom.xml | 2 +- test/protocol-tests-core/pom.xml | 2 +- test/protocol-tests/pom.xml | 2 +- test/sdk-benchmarks/pom.xml | 2 +- test/sdk-native-image-test/pom.xml | 2 +- test/service-test-utils/pom.xml | 2 +- test/stability-tests/pom.xml | 2 +- test/test-utils/pom.xml | 2 +- test/tests-coverage-reporting/pom.xml | 2 +- utils/pom.xml | 2 +- 330 files changed, 491 insertions(+), 416 deletions(-) create mode 100644 .changes/2.16.32.json delete mode 100644 .changes/next-release/feature-AWSBatch-a5021fe.json delete mode 100644 .changes/next-release/feature-AWSCloud9-6460db9.json delete mode 100644 .changes/next-release/feature-AWSCloudFormation-ce57026.json delete mode 100644 .changes/next-release/feature-AWSDataPipeline-23bdeb0.json delete mode 100644 .changes/next-release/feature-AWSDirectConnect-681117c.json delete mode 100644 .changes/next-release/feature-AWSIoT-eceaf2a.json delete mode 100644 .changes/next-release/feature-AWSIoTWireless-bdb5648.json delete mode 100644 .changes/next-release/feature-AWSPriceListService-d9d8643.json delete mode 100644 .changes/next-release/feature-AWSSDKforJavav2-bedacd4.json delete mode 100644 .changes/next-release/feature-AmazonCloudHSM-5749bc7.json delete mode 100644 .changes/next-release/feature-AmazonCognitoSync-ab91ead.json delete mode 100644 .changes/next-release/feature-AmazonComprehend-9c185bd.json delete mode 100644 .changes/next-release/feature-AmazonDetective-283b026.json delete mode 100644 .changes/next-release/feature-AmazonMachineLearning-4673b6f.json delete mode 100644 .changes/next-release/feature-AmazonRedshift-6176455.json delete mode 100644 .changes/next-release/feature-AmazonTranscribeService-63ec310.json delete mode 100644 .changes/next-release/feature-AmazonWorkMail-767e9b2.json diff --git a/.changes/2.16.32.json b/.changes/2.16.32.json new file mode 100644 index 000000000000..27cb469e5e7e --- /dev/null +++ b/.changes/2.16.32.json @@ -0,0 +1,108 @@ +{ + "version": "2.16.32", + "date": "2021-03-31", + "entries": [ + { + "type": "feature", + "category": "Amazon Cognito Sync", + "contributor": "", + "description": "Minor documentation updates and link updates." + }, + { + "type": "feature", + "category": "AWS Cloud9", + "contributor": "", + "description": "Add ImageId input parameter to CreateEnvironmentEC2 endpoint. New parameter enables creation of environments with different AMIs." + }, + { + "type": "feature", + "category": "AWS Batch", + "contributor": "", + "description": "AWS Batch adds support for Amazon EFS File System" + }, + { + "type": "feature", + "category": "Amazon Transcribe Service", + "contributor": "", + "description": "Amazon Transcribe now supports creating custom language models in the following languages: British English (en-GB), Australian English (en-AU), Indian Hindi (hi-IN), and US Spanish (es-US)." + }, + { + "type": "feature", + "category": "AWS SDK for Java v2", + "contributor": "", + "description": "Updated service endpoint metadata." + }, + { + "type": "feature", + "category": "AWS Price List Service", + "contributor": "", + "description": "Minor documentation and link updates." + }, + { + "type": "feature", + "category": "Amazon WorkMail", + "contributor": "", + "description": "This release adds support for mobile device access rules management in Amazon WorkMail." + }, + { + "type": "feature", + "category": "Amazon Detective", + "contributor": "", + "description": "Added the ability to assign tag values to Detective behavior graphs. Tag values can be used for attribute-based access control, and for cost allocation for billing." + }, + { + "type": "feature", + "category": "AWS Data Pipeline", + "contributor": "", + "description": "Minor documentation updates and link updates." + }, + { + "type": "feature", + "category": "AWS CloudFormation", + "contributor": "", + "description": "1. Added a new parameter \"RegionConcurrencyType\" in OperationPreferences. 2. Changed the name of \"AccountUrl\" to \"AccountsUrl\" in \"DeploymentTargets\" parameter." + }, + { + "type": "feature", + "category": "Amazon Comprehend", + "contributor": "", + "description": "Support for customer managed KMS encryption of Comprehend custom models" + }, + { + "type": "feature", + "category": "AWS Direct Connect", + "contributor": "", + "description": "This release adds MACsec support to AWS Direct Connect" + }, + { + "type": "feature", + "category": "Amazon Redshift", + "contributor": "", + "description": "Enable customers to share access to their Redshift clusters from other VPCs (including VPCs from other accounts)." + }, + { + "type": "feature", + "category": "AWS IoT Wireless", + "contributor": "", + "description": "Add Sidewalk support to APIs: GetWirelessDevice, ListWirelessDevices, GetWirelessDeviceStatistics. Add Gateway connection status in GetWirelessGatewayStatistics API." + }, + { + "type": "feature", + "category": "AWS IoT", + "contributor": "", + "description": "Added ability to prefix search on attribute value for ListThings API." + }, + { + "type": "feature", + "category": "Amazon Machine Learning", + "contributor": "", + "description": "Minor documentation updates and link updates." + }, + { + "type": "feature", + "category": "Amazon CloudHSM", + "contributor": "", + "description": "Minor documentation and link updates." + } + ] +} \ No newline at end of file diff --git a/.changes/next-release/feature-AWSBatch-a5021fe.json b/.changes/next-release/feature-AWSBatch-a5021fe.json deleted file mode 100644 index 5c9150a156e6..000000000000 --- a/.changes/next-release/feature-AWSBatch-a5021fe.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Batch", - "contributor": "", - "description": "AWS Batch adds support for Amazon EFS File System" -} diff --git a/.changes/next-release/feature-AWSCloud9-6460db9.json b/.changes/next-release/feature-AWSCloud9-6460db9.json deleted file mode 100644 index 7e2518c3a1d9..000000000000 --- a/.changes/next-release/feature-AWSCloud9-6460db9.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Cloud9", - "contributor": "", - "description": "Add ImageId input parameter to CreateEnvironmentEC2 endpoint. New parameter enables creation of environments with different AMIs." -} diff --git a/.changes/next-release/feature-AWSCloudFormation-ce57026.json b/.changes/next-release/feature-AWSCloudFormation-ce57026.json deleted file mode 100644 index c3570eb790bc..000000000000 --- a/.changes/next-release/feature-AWSCloudFormation-ce57026.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS CloudFormation", - "contributor": "", - "description": "1. Added a new parameter \"RegionConcurrencyType\" in OperationPreferences. 2. Changed the name of \"AccountUrl\" to \"AccountsUrl\" in \"DeploymentTargets\" parameter." -} diff --git a/.changes/next-release/feature-AWSDataPipeline-23bdeb0.json b/.changes/next-release/feature-AWSDataPipeline-23bdeb0.json deleted file mode 100644 index 786454e0dddd..000000000000 --- a/.changes/next-release/feature-AWSDataPipeline-23bdeb0.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Data Pipeline", - "contributor": "", - "description": "Minor documentation updates and link updates." -} diff --git a/.changes/next-release/feature-AWSDirectConnect-681117c.json b/.changes/next-release/feature-AWSDirectConnect-681117c.json deleted file mode 100644 index 80f886ca56cf..000000000000 --- a/.changes/next-release/feature-AWSDirectConnect-681117c.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Direct Connect", - "contributor": "", - "description": "This release adds MACsec support to AWS Direct Connect" -} diff --git a/.changes/next-release/feature-AWSIoT-eceaf2a.json b/.changes/next-release/feature-AWSIoT-eceaf2a.json deleted file mode 100644 index d8b6afee8c8e..000000000000 --- a/.changes/next-release/feature-AWSIoT-eceaf2a.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS IoT", - "contributor": "", - "description": "Added ability to prefix search on attribute value for ListThings API." -} diff --git a/.changes/next-release/feature-AWSIoTWireless-bdb5648.json b/.changes/next-release/feature-AWSIoTWireless-bdb5648.json deleted file mode 100644 index e9772b96d907..000000000000 --- a/.changes/next-release/feature-AWSIoTWireless-bdb5648.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS IoT Wireless", - "contributor": "", - "description": "Add Sidewalk support to APIs: GetWirelessDevice, ListWirelessDevices, GetWirelessDeviceStatistics. Add Gateway connection status in GetWirelessGatewayStatistics API." -} diff --git a/.changes/next-release/feature-AWSPriceListService-d9d8643.json b/.changes/next-release/feature-AWSPriceListService-d9d8643.json deleted file mode 100644 index 7940782f5ac1..000000000000 --- a/.changes/next-release/feature-AWSPriceListService-d9d8643.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS Price List Service", - "contributor": "", - "description": "Minor documentation and link updates." -} diff --git a/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json b/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json deleted file mode 100644 index ae3f84993e9e..000000000000 --- a/.changes/next-release/feature-AWSSDKforJavav2-bedacd4.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS SDK for Java v2", - "contributor": "", - "description": "Updated service endpoint metadata." -} diff --git a/.changes/next-release/feature-AmazonCloudHSM-5749bc7.json b/.changes/next-release/feature-AmazonCloudHSM-5749bc7.json deleted file mode 100644 index 5e1613cd5c58..000000000000 --- a/.changes/next-release/feature-AmazonCloudHSM-5749bc7.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon CloudHSM", - "contributor": "", - "description": "Minor documentation and link updates." -} diff --git a/.changes/next-release/feature-AmazonCognitoSync-ab91ead.json b/.changes/next-release/feature-AmazonCognitoSync-ab91ead.json deleted file mode 100644 index 59323eef698f..000000000000 --- a/.changes/next-release/feature-AmazonCognitoSync-ab91ead.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Cognito Sync", - "contributor": "", - "description": "Minor documentation updates and link updates." -} diff --git a/.changes/next-release/feature-AmazonComprehend-9c185bd.json b/.changes/next-release/feature-AmazonComprehend-9c185bd.json deleted file mode 100644 index b9347a6a2613..000000000000 --- a/.changes/next-release/feature-AmazonComprehend-9c185bd.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Comprehend", - "contributor": "", - "description": "Support for customer managed KMS encryption of Comprehend custom models" -} diff --git a/.changes/next-release/feature-AmazonDetective-283b026.json b/.changes/next-release/feature-AmazonDetective-283b026.json deleted file mode 100644 index f1c98fa51c32..000000000000 --- a/.changes/next-release/feature-AmazonDetective-283b026.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Detective", - "contributor": "", - "description": "Added the ability to assign tag values to Detective behavior graphs. Tag values can be used for attribute-based access control, and for cost allocation for billing." -} diff --git a/.changes/next-release/feature-AmazonMachineLearning-4673b6f.json b/.changes/next-release/feature-AmazonMachineLearning-4673b6f.json deleted file mode 100644 index ef811764e1d2..000000000000 --- a/.changes/next-release/feature-AmazonMachineLearning-4673b6f.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Machine Learning", - "contributor": "", - "description": "Minor documentation updates and link updates." -} diff --git a/.changes/next-release/feature-AmazonRedshift-6176455.json b/.changes/next-release/feature-AmazonRedshift-6176455.json deleted file mode 100644 index 1b5497e99ea6..000000000000 --- a/.changes/next-release/feature-AmazonRedshift-6176455.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Redshift", - "contributor": "", - "description": "Enable customers to share access to their Redshift clusters from other VPCs (including VPCs from other accounts)." -} diff --git a/.changes/next-release/feature-AmazonTranscribeService-63ec310.json b/.changes/next-release/feature-AmazonTranscribeService-63ec310.json deleted file mode 100644 index 1ab95541fb27..000000000000 --- a/.changes/next-release/feature-AmazonTranscribeService-63ec310.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Transcribe Service", - "contributor": "", - "description": "Amazon Transcribe now supports creating custom language models in the following languages: British English (en-GB), Australian English (en-AU), Indian Hindi (hi-IN), and US Spanish (es-US)." -} diff --git a/.changes/next-release/feature-AmazonWorkMail-767e9b2.json b/.changes/next-release/feature-AmazonWorkMail-767e9b2.json deleted file mode 100644 index f8de4f5c196f..000000000000 --- a/.changes/next-release/feature-AmazonWorkMail-767e9b2.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon WorkMail", - "contributor": "", - "description": "This release adds support for mobile device access rules management in Amazon WorkMail." -} diff --git a/CHANGELOG.md b/CHANGELOG.md index c6dc01100066..277dc3de3e4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,72 @@ +# __2.16.32__ __2021-03-31__ +## __AWS Batch__ + - ### Features + - AWS Batch adds support for Amazon EFS File System + +## __AWS Cloud9__ + - ### Features + - Add ImageId input parameter to CreateEnvironmentEC2 endpoint. New parameter enables creation of environments with different AMIs. + +## __AWS CloudFormation__ + - ### Features + - 1. Added a new parameter "RegionConcurrencyType" in OperationPreferences. 2. Changed the name of "AccountUrl" to "AccountsUrl" in "DeploymentTargets" parameter. + +## __AWS Data Pipeline__ + - ### Features + - Minor documentation updates and link updates. + +## __AWS Direct Connect__ + - ### Features + - This release adds MACsec support to AWS Direct Connect + +## __AWS IoT__ + - ### Features + - Added ability to prefix search on attribute value for ListThings API. + +## __AWS IoT Wireless__ + - ### Features + - Add Sidewalk support to APIs: GetWirelessDevice, ListWirelessDevices, GetWirelessDeviceStatistics. Add Gateway connection status in GetWirelessGatewayStatistics API. + +## __AWS Price List Service__ + - ### Features + - Minor documentation and link updates. + +## __AWS SDK for Java v2__ + - ### Features + - Updated service endpoint metadata. + +## __Amazon CloudHSM__ + - ### Features + - Minor documentation and link updates. + +## __Amazon Cognito Sync__ + - ### Features + - Minor documentation updates and link updates. + +## __Amazon Comprehend__ + - ### Features + - Support for customer managed KMS encryption of Comprehend custom models + +## __Amazon Detective__ + - ### Features + - Added the ability to assign tag values to Detective behavior graphs. Tag values can be used for attribute-based access control, and for cost allocation for billing. + +## __Amazon Machine Learning__ + - ### Features + - Minor documentation updates and link updates. + +## __Amazon Redshift__ + - ### Features + - Enable customers to share access to their Redshift clusters from other VPCs (including VPCs from other accounts). + +## __Amazon Transcribe Service__ + - ### Features + - Amazon Transcribe now supports creating custom language models in the following languages: British English (en-GB), Australian English (en-AU), Indian Hindi (hi-IN), and US Spanish (es-US). + +## __Amazon WorkMail__ + - ### Features + - This release adds support for mobile device access rules management in Amazon WorkMail. + # __2.16.31__ __2021-03-30__ ## __AWS Config__ - ### Features diff --git a/README.md b/README.md index b51b81b1a4e9..d3b99826306c 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ To automatically manage module versions (currently all modules have the same ver