diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e3d9fa56f0..df7c7acfa60 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,28 @@ +Release v1.36.13 (2020-12-21) +=== + +### Service Client Updates +* `service/apigateway`: Updates service documentation + * Documentation updates for Amazon API Gateway. +* `service/batch`: Updates service documentation + * Documentation updates for batch +* `service/config`: Updates service API, documentation, and paginators +* `service/connectparticipant`: Updates service API and documentation +* `service/dms`: Updates service API and documentation + * AWS DMS launches support for AWS Secrets Manager to manage source and target database credentials. +* `service/ec2`: Updates service API and documentation + * This release adds Tag On Create feature support for the AllocateAddress API. +* `service/glue`: Updates service API and documentation + * Add 4 connection properties: SECRET_ID, CONNECTOR_URL, CONNECTOR_TYPE, CONNECTOR_CLASS_NAME. Add two connection types: MARKETPLACE, CUSTOM +* `service/managedblockchain`: Updates service API and documentation +* `service/outposts`: Updates service API and documentation +* `service/qldb-session`: Updates service API and documentation +* `service/s3`: Updates service API and examples + * Format GetObject's Expires header to be an http-date instead of iso8601 +* `service/securityhub`: Updates service documentation +* `service/service-quotas`: Updates service API and documentation +* `service/servicecatalog-appregistry`: Updates service API and documentation + Release v1.36.12 (2020-12-18) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 72dcdfad248..804bb074dcf 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -8553,6 +8553,25 @@ var awsusgovPartition = partition{ "us-gov-west-1": endpoint{}, }, }, + "fsx": service{ + + Endpoints: endpoints{ + "fips-prod-us-gov-east-1": endpoint{ + Hostname: "fsx-fips.us-gov-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-east-1", + }, + }, + "fips-prod-us-gov-west-1": endpoint{ + Hostname: "fsx-fips.us-gov-west-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-west-1", + }, + }, + "us-gov-east-1": endpoint{}, + "us-gov-west-1": endpoint{}, + }, + }, "glacier": service{ Endpoints: endpoints{ diff --git a/aws/version.go b/aws/version.go index 70325bd761c..4f19cacac77 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.36.12" +const SDKVersion = "1.36.13" diff --git a/models/apis/apigateway/2015-07-09/docs-2.json b/models/apis/apigateway/2015-07-09/docs-2.json index 1be3a53daa0..7878f3feeec 100644 --- a/models/apis/apigateway/2015-07-09/docs-2.json +++ b/models/apis/apigateway/2015-07-09/docs-2.json @@ -881,7 +881,7 @@ "MethodSetting$throttlingBurstLimit": "

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

", "MethodSetting$cacheTtlInSeconds": "

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

", "QuotaSettings$limit": "

The maximum number of requests that can be made in a given time period.

", - "QuotaSettings$offset": "

The number of requests subtracted from the given limit in the initial time period.

", + "QuotaSettings$offset": "

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

", "TestInvokeAuthorizerResponse$clientStatus": "

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

", "TestInvokeMethodResponse$status": "

The HTTP status code.

", "ThrottleSettings$burstLimit": "

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

" diff --git a/models/apis/batch/2016-08-10/docs-2.json b/models/apis/batch/2016-08-10/docs-2.json index fa2a2691f7a..bf8e0d389e6 100644 --- a/models/apis/batch/2016-08-10/docs-2.json +++ b/models/apis/batch/2016-08-10/docs-2.json @@ -3,10 +3,10 @@ "service": "

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 utilizes the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure, while also adopting 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 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.

", "operations": { "CancelJob": "

Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING are not canceled (but the API operation still succeeds, even if no job is canceled); these jobs must be terminated with the TerminateJob operation.

", - "CreateComputeEnvironment": "

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.

Multi-node parallel jobs are not supported on Spot Instances.

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:

  1. Create a new compute environment with the new AMI.

  2. Add the compute environment to an existing job queue.

  3. Remove the earlier compute environment from your job queue.

  4. Delete the earlier compute environment.

", + "CreateComputeEnvironment": "

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.

Multi-node parallel jobs are not supported on Spot Instances.

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:

  1. Create a new compute environment with the new AMI.

  2. Add the compute environment to an existing job queue.

  3. Remove the earlier compute environment from your job queue.

  4. Delete the earlier compute environment.

", "CreateJobQueue": "

Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

", "DeleteComputeEnvironment": "

Deletes an AWS Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment will end up in an invalid state.

", - "DeleteJobQueue": "

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.

It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

", + "DeleteJobQueue": "

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.

It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

", "DeregisterJobDefinition": "

Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.

", "DescribeComputeEnvironments": "

Describes one or more of your compute environments.

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

", "DescribeJobDefinitions": "

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

", @@ -60,7 +60,7 @@ } }, "AttemptContainerDetail": { - "base": "

An object representing the details of a container that is part of a job attempt.

", + "base": "

An object representing the details of a container that's part of a job attempt.

", "refs": { "AttemptDetail$container": "

Details about the container in this job attempt.

" } @@ -97,9 +97,9 @@ "CEState": { "base": null, "refs": { - "ComputeEnvironmentDetail$state": "

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state do not scale out. However, they scale in to minvCpus value after instances become idle.

", - "CreateComputeEnvironmentRequest$state": "

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

", - "UpdateComputeEnvironmentRequest$state": "

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

" + "ComputeEnvironmentDetail$state": "

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

", + "CreateComputeEnvironmentRequest$state": "

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

", + "UpdateComputeEnvironmentRequest$state": "

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

" } }, "CEStatus": { @@ -111,7 +111,7 @@ "CEType": { "base": null, "refs": { - "ComputeEnvironmentDetail$type": "

The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.

", + "ComputeEnvironmentDetail$type": "

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

", "CreateComputeEnvironmentRequest$type": "

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

" } }, @@ -124,11 +124,11 @@ "CRType": { "base": null, "refs": { - "ComputeResource$type": "

The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.

" + "ComputeResource$type": "

The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the AWS Batch User Guide.

" } }, "CancelJobRequest": { - "base": null, + "base": "

Contains the parameters for CancelJob.

", "refs": { } }, @@ -138,7 +138,7 @@ } }, "ClientException": { - "base": "

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't valid.

", + "base": "

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that's not valid.

", "refs": { } }, @@ -155,7 +155,7 @@ } }, "ComputeEnvironmentOrder": { - "base": "

The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

", + "base": "

The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

", "refs": { "ComputeEnvironmentOrders$member": null } @@ -163,26 +163,26 @@ "ComputeEnvironmentOrders": { "base": null, "refs": { - "CreateJobQueueRequest$computeEnvironmentOrder": "

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

", + "CreateJobQueueRequest$computeEnvironmentOrder": "

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

", "JobQueueDetail$computeEnvironmentOrder": "

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

", - "UpdateJobQueueRequest$computeEnvironmentOrder": "

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

" + "UpdateJobQueueRequest$computeEnvironmentOrder": "

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

" } }, "ComputeResource": { - "base": "

An object representing an AWS Batch compute resource.

", + "base": "

An object representing an AWS Batch compute resource. For more information, see Compute Environments in the AWS Batch User Guide.

", "refs": { - "ComputeEnvironmentDetail$computeResources": "

The compute resources defined for the compute environment.

", + "ComputeEnvironmentDetail$computeResources": "

The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

", "CreateComputeEnvironmentRequest$computeResources": "

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

" } }, "ComputeResourceUpdate": { - "base": "

An object representing the attributes of a compute environment that can be updated.

", + "base": "

An object representing the attributes of a compute environment that can be updated. For more information, see Compute Environments in the AWS Batch User Guide.

", "refs": { - "UpdateComputeEnvironmentRequest$computeResources": "

Details of the compute resources managed by the compute environment. Required for a managed compute environment.

" + "UpdateComputeEnvironmentRequest$computeResources": "

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

" } }, "ContainerDetail": { - "base": "

An object representing the details of a container that is part of a job.

", + "base": "

An object representing the details of a container that's part of a job.

", "refs": { "JobDetail$container": "

An object representing the details of the container that's associated with the job.

" } @@ -191,11 +191,11 @@ "base": "

The overrides that should be sent to a container.

", "refs": { "NodePropertyOverride$containerOverrides": "

The overrides that should be sent to a node range.

", - "SubmitJobRequest$containerOverrides": "

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

" + "SubmitJobRequest$containerOverrides": "

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that's specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

" } }, "ContainerProperties": { - "base": "

Container properties are used in job definitions to describe the container that is launched as part of a job.

", + "base": "

Container properties are used in job definitions to describe the container that's launched as part of a job.

", "refs": { "JobDefinition$containerProperties": "

An object with various properties specific to container-based jobs.

", "NodeRangeProperty$container": "

The container details for the node range.

", @@ -205,11 +205,11 @@ "ContainerSummary": { "base": "

An object representing summary details of a container within a job.

", "refs": { - "JobSummary$container": "

An object representing the details of the container that is associated with the job.

" + "JobSummary$container": "

An object representing the details of the container that's associated with the job.

" } }, "CreateComputeEnvironmentRequest": { - "base": null, + "base": "

Contains the parameters for CreateComputeEnvironment.

", "refs": { } }, @@ -219,7 +219,7 @@ } }, "CreateJobQueueRequest": { - "base": null, + "base": "

Contains the parameters for CreateJobQueue.

", "refs": { } }, @@ -229,7 +229,7 @@ } }, "DeleteComputeEnvironmentRequest": { - "base": null, + "base": "

Contains the parameters for DeleteComputeEnvironment.

", "refs": { } }, @@ -239,7 +239,7 @@ } }, "DeleteJobQueueRequest": { - "base": null, + "base": "

Contains the parameters for DeleteJobQueue.

", "refs": { } }, @@ -259,7 +259,7 @@ } }, "DescribeComputeEnvironmentsRequest": { - "base": null, + "base": "

Contains the parameters for DescribeComputeEnvironments.

", "refs": { } }, @@ -269,7 +269,7 @@ } }, "DescribeJobDefinitionsRequest": { - "base": null, + "base": "

Contains the parameters for DescribeJobDefinitions.

", "refs": { } }, @@ -279,7 +279,7 @@ } }, "DescribeJobQueuesRequest": { - "base": null, + "base": "

Contains the parameters for DescribeJobQueues.

", "refs": { } }, @@ -289,7 +289,7 @@ } }, "DescribeJobsRequest": { - "base": null, + "base": "

Contains the parameters for DescribeJobs.

", "refs": { } }, @@ -331,7 +331,7 @@ "Ec2ConfigurationList": { "base": null, "refs": { - "ComputeResource$ec2Configuration": "

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL1.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

" + "ComputeResource$ec2Configuration": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL1.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

" } }, "EnvironmentVariables": { @@ -376,7 +376,7 @@ "ImageType": { "base": null, "refs": { - "Ec2Configuration$imageType": "

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.

ECS_AL2

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.

ECS_AL2_NVIDIA

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.

ECS_AL1

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.

" + "Ec2Configuration$imageType": "

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.

ECS_AL2

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.

ECS_AL2_NVIDIA

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.

ECS_AL1

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.

" } }, "Integer": { @@ -385,17 +385,17 @@ "ArrayJobStatusSummary$value": null, "ArrayProperties$size": "

The size of the array job.

", "ArrayPropertiesDetail$size": "

The size of the array job. This parameter is returned for parent array jobs.

", - "ArrayPropertiesDetail$index": "

The job index within the array that is associated with this job. This parameter is returned for array job children.

", + "ArrayPropertiesDetail$index": "

The job index within the array that's associated with this job. This parameter is returned for array job children.

", "ArrayPropertiesSummary$size": "

The size of the array job. This parameter is returned for parent array jobs.

", - "ArrayPropertiesSummary$index": "

The job index within the array that is associated with this job. This parameter is returned for children of array jobs.

", + "ArrayPropertiesSummary$index": "

The job index within the array that's associated with this job. This parameter is returned for children of array jobs.

", "AttemptContainerDetail$exitCode": "

The exit code for the job attempt. A non-zero exit code is considered a failure.

", "ComputeEnvironmentOrder$order": "

The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

", "ComputeResource$minvCpus": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", - "ComputeResource$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch may need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch will never go above maxvCpus by more than a single instance (e.g., no more than a single instance from among those specified in your compute environment).

", + "ComputeResource$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch will never go above maxvCpus by more than a single instance (e.g., no more than a single instance from among those specified in your compute environment).

", "ComputeResource$desiredvCpus": "

The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", - "ComputeResource$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$minvCpus": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

This parameter isnt applicable to jobs running on Fargate resources, and shouldn't be specified.

", - "ComputeResourceUpdate$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

", + "ComputeResource$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", + "ComputeResourceUpdate$minvCpus": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", + "ComputeResourceUpdate$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch will never go above maxvCpus by more than a single instance (e.g., no more than a single instance from among those specified in your compute environment).

", "ComputeResourceUpdate$desiredvCpus": "

The desired number of Amazon EC2 vCPUS in the compute environment.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", "ContainerDetail$vcpus": "

The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

This parameter isn't applicable to jobs running on Fargate resources. Jobs running on Fargate resources must specify the vCPU requirement for the job using resourceRequirements.

", "ContainerDetail$memory": "

For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

", @@ -405,16 +405,16 @@ "ContainerProperties$vcpus": "

This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement structure. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. Jobs running on Fargate resources must specify the vCPU requirement for the job using resourceRequirements.

", "ContainerProperties$memory": "

This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resources can specify the memory requirement using the ResourceRequirement structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.

", "ContainerSummary$exitCode": "

The exit code to return upon completion.

", - "CreateJobQueueRequest$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.

", + "CreateJobQueueRequest$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments cannot be mixed.

", "DescribeComputeEnvironmentsRequest$maxResults": "

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

", "DescribeJobDefinitionsRequest$maxResults": "

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

", "DescribeJobQueuesRequest$maxResults": "

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

", "JobDefinition$revision": "

The revision of the job definition.

", - "JobQueueDetail$priority": "

The priority of the job queue.

", + "JobQueueDetail$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments cannot be mixed.

", "JobTimeout$attemptDurationSeconds": "

The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.

", "LinuxParameters$sharedMemorySize": "

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

", "LinuxParameters$maxSwap": "

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

", - "LinuxParameters$swappiness": "

This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

", + "LinuxParameters$swappiness": "

This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

", "ListJobsRequest$maxResults": "

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

", "NodeDetails$nodeIndex": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

", "NodeOverrides$numNodes": "

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:

", @@ -423,11 +423,11 @@ "NodePropertiesSummary$numNodes": "

The number of nodes associated with a multi-node parallel job.

", "NodePropertiesSummary$nodeIndex": "

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

", "RegisterJobDefinitionResponse$revision": "

The revision of the job definition.

", - "RetryStrategy$attempts": "

The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

", + "RetryStrategy$attempts": "

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

", "Tmpfs$size": "

The size (in MiB) of the tmpfs volume.

", "Ulimit$hardLimit": "

The hard limit for the ulimit type.

", "Ulimit$softLimit": "

The soft limit for the ulimit type.

", - "UpdateJobQueueRequest$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.

" + "UpdateJobQueueRequest$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments cannot be mixed.

" } }, "JQState": { @@ -502,7 +502,7 @@ "JobStatus": { "base": null, "refs": { - "JobDetail$status": "

The current status for the job.

If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.

", + "JobDetail$status": "

The current status for the job.

If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.

", "JobSummary$status": "

The current status for the job.

", "ListJobsRequest$jobStatus": "

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

" } @@ -524,7 +524,7 @@ "refs": { "JobDefinition$timeout": "

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished.

", "JobDetail$timeout": "

The timeout configuration for the job.

", - "RegisterJobDefinitionRequest$timeout": "

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

", + "RegisterJobDefinitionRequest$timeout": "

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.

", "SubmitJobRequest$timeout": "

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

" } }, @@ -548,7 +548,7 @@ } }, "ListJobsRequest": { - "base": null, + "base": "

Contains the parameters for ListJobs.

", "refs": { } }, @@ -570,7 +570,7 @@ "LogConfiguration": { "base": "

Log configuration options to send to a custom log driver for the container.

", "refs": { - "ContainerDetail$logConfiguration": "

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

", + "ContainerDetail$logConfiguration": "

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

", "ContainerProperties$logConfiguration": "

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

" } }, @@ -583,7 +583,7 @@ "LogDriver": { "base": null, "refs": { - "LogConfiguration$logDriver": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that isn't listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" + "LogConfiguration$logDriver": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs running on Fargate resources are restricted to the awslogs and splunk log drivers.
awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that'sn't listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" } }, "Long": { @@ -600,7 +600,7 @@ } }, "MountPoint": { - "base": "

Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

", + "base": "

Details on a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

", "refs": { "MountPoints$member": null } @@ -635,11 +635,11 @@ "NodeDetails": { "base": "

An object representing the details of a multi-node parallel job node.

", "refs": { - "JobDetail$nodeDetails": "

An object representing the details of a node that is associated with a multi-node parallel job.

" + "JobDetail$nodeDetails": "

An object representing the details of a node that's associated with a multi-node parallel job.

" } }, "NodeOverrides": { - "base": "

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

This isn't applicable to jobs running on Fargate resources and shouldn't be provided; use containerOverrides instead.

", + "base": "

Object representing any node overrides to a job definition that's used in a SubmitJob API operation.

This isn't applicable to jobs running on Fargate resources and shouldn't be provided; use containerOverrides instead.

", "refs": { "SubmitJobRequest$nodeOverrides": "

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.

" } @@ -653,13 +653,13 @@ } }, "NodePropertiesSummary": { - "base": "

An object representing the properties of a node that is associated with a multi-node parallel job.

", + "base": "

An object representing the properties of a node that's associated with a multi-node parallel job.

", "refs": { "JobSummary$nodeProperties": "

The node properties for a single node in a job summary list.

This isn't applicable to jobs running on Fargate resources.

" } }, "NodePropertyOverride": { - "base": "

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

", + "base": "

Object representing any node overrides to a job definition that's used in a SubmitJob API operation.

", "refs": { "NodePropertyOverrides$member": null } @@ -706,7 +706,7 @@ } }, "RegisterJobDefinitionRequest": { - "base": null, + "base": "

Contains the parameters for RegisterJobDefinition.

", "refs": { } }, @@ -746,7 +746,7 @@ "refs": { "JobDefinition$retryStrategy": "

The retry strategy to use for failed jobs that are submitted with this job definition.

", "JobDetail$retryStrategy": "

The retry strategy to use for this job if an attempt fails.

", - "RegisterJobDefinitionRequest$retryStrategy": "

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

", + "RegisterJobDefinitionRequest$retryStrategy": "

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

", "SubmitJobRequest$retryStrategy": "

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

" } }, @@ -774,21 +774,21 @@ "refs": { "ArrayJobStatusSummary$key": null, "AttemptContainerDetail$containerInstanceArn": "

The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.

", - "AttemptContainerDetail$taskArn": "

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.

", + "AttemptContainerDetail$taskArn": "

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.

", "AttemptContainerDetail$reason": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

", "AttemptContainerDetail$logStreamName": "

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

", "AttemptDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the job attempt.

", "CancelJobRequest$jobId": "

The AWS Batch job ID of the job to cancel.

", "CancelJobRequest$reason": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

", "ClientException$message": null, - "ComputeEnvironmentDetail$computeEnvironmentName": "

The name of the compute environment.

", + "ComputeEnvironmentDetail$computeEnvironmentName": "

The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", "ComputeEnvironmentDetail$computeEnvironmentArn": "

The Amazon Resource Name (ARN) of the compute environment.

", "ComputeEnvironmentDetail$ecsClusterArn": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

", "ComputeEnvironmentDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the compute environment.

", - "ComputeEnvironmentDetail$serviceRole": "

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.

", + "ComputeEnvironmentDetail$serviceRole": "

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

", "ComputeEnvironmentOrder$computeEnvironment": "

The Amazon Resource Name (ARN) of the compute environment.

", "ComputeResource$imageId": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

", - "ComputeResource$ec2KeyPair": "

The Amazon EC2 key pair that is used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", + "ComputeResource$ec2KeyPair": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", "ComputeResource$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", "ComputeResource$placementGroup": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

", "ComputeResource$spotIamFleetRole": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.

", @@ -798,7 +798,7 @@ "ContainerDetail$user": "

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

", "ContainerDetail$reason": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

", "ContainerDetail$containerInstanceArn": "

The Amazon Resource Name (ARN) of the container instance that the container is running on.

", - "ContainerDetail$taskArn": "

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

", + "ContainerDetail$taskArn": "

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

", "ContainerDetail$logStreamName": "

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

", "ContainerDetail$instanceType": "

The instance type of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs running on Fargate resources.

", "ContainerOverrides$instanceType": "

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.

", @@ -809,22 +809,22 @@ "ContainerProperties$instanceType": "

The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.

This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.

", "ContainerSummary$reason": "

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

", "CreateComputeEnvironmentRequest$computeEnvironmentName": "

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", - "CreateComputeEnvironmentRequest$serviceRole": "

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

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

", - "CreateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment.

", + "CreateComputeEnvironmentRequest$serviceRole": "

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.

", + "CreateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", "CreateComputeEnvironmentResponse$computeEnvironmentArn": "

The Amazon Resource Name (ARN) of the compute environment.

", - "CreateJobQueueRequest$jobQueueName": "

The name of the job queue.

", + "CreateJobQueueRequest$jobQueueName": "

The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

", "CreateJobQueueResponse$jobQueueName": "

The name of the job queue.

", "CreateJobQueueResponse$jobQueueArn": "

The Amazon Resource Name (ARN) of the job queue.

", "DeleteComputeEnvironmentRequest$computeEnvironment": "

The name or Amazon Resource Name (ARN) of the compute environment to delete.

", "DeleteJobQueueRequest$jobQueue": "

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

", "DeregisterJobDefinitionRequest$jobDefinition": "

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

", - "DescribeComputeEnvironmentsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", + "DescribeComputeEnvironmentsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", "DescribeComputeEnvironmentsResponse$nextToken": "

The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "DescribeJobDefinitionsRequest$jobDefinitionName": "

The name of the job definition to describe.

", "DescribeJobDefinitionsRequest$status": "

The status used to filter job definitions.

", - "DescribeJobDefinitionsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", + "DescribeJobDefinitionsRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", "DescribeJobDefinitionsResponse$nextToken": "

The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", - "DescribeJobQueuesRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", + "DescribeJobQueuesRequest$nextToken": "

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", "DescribeJobQueuesResponse$nextToken": "

The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "Device$hostPath": "

The path for the device on the host container instance.

", "Device$containerPath": "

The path inside the container used to expose the host device. By default the hostPath value is used.

", @@ -832,7 +832,7 @@ "EvaluateOnExit$onReason": "

Contains a glob pattern to match against the Reason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

", "EvaluateOnExit$onExitCode": "

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The patten can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

", "FargatePlatformConfiguration$platformVersion": "

The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

", - "Host$sourcePath": "

The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

", + "Host$sourcePath": "

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

", "JobDefinition$jobDefinitionName": "

The name of the job definition.

", "JobDefinition$jobDefinitionArn": "

The Amazon Resource Name (ARN) for the job definition.

", "JobDefinition$status": "

The status of the job definition.

", @@ -843,7 +843,7 @@ "JobDetail$jobId": "

The ID for the job.

", "JobDetail$jobQueue": "

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

", "JobDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the job.

", - "JobDetail$jobDefinition": "

The job definition that is used by this job.

", + "JobDetail$jobDefinition": "

The job definition that's used by this job.

", "JobQueueDetail$jobQueueName": "

The name of the job queue.

", "JobQueueDetail$jobQueueArn": "

The Amazon Resource Name (ARN) of the job queue.

", "JobQueueDetail$statusReason": "

A short, human-readable string to provide additional details about the current status of the job queue.

", @@ -859,7 +859,7 @@ "ListJobsRequest$jobQueue": "

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

", "ListJobsRequest$arrayJobId": "

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

", "ListJobsRequest$multiNodeJobId": "

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

", - "ListJobsRequest$nextToken": "

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", + "ListJobsRequest$nextToken": "

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

", "ListJobsResponse$nextToken": "

The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "ListTagsForResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", "LogConfigurationOptionsMap$key": null, @@ -870,13 +870,13 @@ "NetworkInterface$ipv6Address": "

The private IPv6 address for the network interface.

", "NetworkInterface$privateIpv4Address": "

The private IPv4 address for the network interface.

", "NodePropertyOverride$targetNodes": "

The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range.

", - "NodeRangeProperty$targetNodes": "

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

", + "NodeRangeProperty$targetNodes": "

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

", "ParametersMap$key": null, "ParametersMap$value": null, "RegisterJobDefinitionRequest$jobDefinitionName": "

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", "RegisterJobDefinitionResponse$jobDefinitionName": "

The name of the job definition.

", "RegisterJobDefinitionResponse$jobDefinitionArn": "

The Amazon Resource Name (ARN) of the job definition.

", - "ResourceRequirement$value": "

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type=\"GPU\"

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs are not available for jobs running on Fargate resources.
type=\"MEMORY\"

For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.

For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.

value = 0.5

VCPU = 0.25

value = 1

VCPU = 0.25 or 0.5

value = 2

VCPU = 0.25, 0.5, or 1

value = 3

VCPU = 0.5, or 1

value = 4

VCPU = 0.5, 1, or 2

value = 5, 6, or 7

VCPU = 1 or 2

value = 8

VCPU = 1, 2, or 4

value = 9, 10, 11, 12, 13, 14, 15, or 16

VCPU = 2 or 4

value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30

VCPU = 4

type=\"VCPU\"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4

value = 0.25

MEMORY = 0.5, 1, or 2

value = 0.5

MEMORY = 1, 2, 3, or 4

value = 1

MEMORY = 2, 3, 4, 5, 6, 7, or 8

value = 2

MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16

value = 4

MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30

", + "ResourceRequirement$value": "

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type=\"GPU\"

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs are not available for jobs running on Fargate resources.
type=\"MEMORY\"

For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.

For jobs running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

VCPU = 2 or 4

value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

VCPU = 4

type=\"VCPU\"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

", "Secret$name": "

The name of the secret.

", "Secret$valueFrom": "

The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.

If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

", "ServerException$message": null, @@ -896,8 +896,8 @@ "Ulimit$name": "

The type of the ulimit.

", "UntagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", "UpdateComputeEnvironmentRequest$computeEnvironment": "

The name or full Amazon Resource Name (ARN) of the compute environment to update.

", - "UpdateComputeEnvironmentRequest$serviceRole": "

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

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

", - "UpdateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment.

", + "UpdateComputeEnvironmentRequest$serviceRole": "

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

", + "UpdateComputeEnvironmentResponse$computeEnvironmentName": "

The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", "UpdateComputeEnvironmentResponse$computeEnvironmentArn": "

The Amazon Resource Name (ARN) of the compute environment.

", "UpdateJobQueueRequest$jobQueue": "

The name or the Amazon Resource Name (ARN) of the job queue.

", "UpdateJobQueueResponse$jobQueueName": "

The name of the job queue.

", @@ -908,14 +908,14 @@ "StringList": { "base": null, "refs": { - "ComputeResource$instanceTypes": "

The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

", + "ComputeResource$instanceTypes": "

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) on the fly that match the demand of your job queues.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.

", "ComputeResource$subnets": "

The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. This parameter is required for jobs running on Fargate resources, where it can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

", "ComputeResource$securityGroupIds": "

The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs running on Fargate resources and must contain at least one security group. (Fargate does not support launch templates.) If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.

", "ComputeResourceUpdate$subnets": "

The VPC subnets that the compute resources are launched into. This parameter is required for jobs running on Fargate compute resources, where it can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide. This can't be specified for EC2 compute resources. Providing an empty list will be handled as if this parameter wasn't specified and no change is made.

", - "ComputeResourceUpdate$securityGroupIds": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no changeis made.

", - "ContainerDetail$command": "

The command that is passed to the container.

", + "ComputeResourceUpdate$securityGroupIds": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is made.

", + "ContainerDetail$command": "

The command that's passed to the container.

", "ContainerOverrides$command": "

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

", - "ContainerProperties$command": "

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

", + "ContainerProperties$command": "

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

", "DescribeComputeEnvironmentsRequest$computeEnvironments": "

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

", "DescribeJobDefinitionsRequest$jobDefinitions": "

A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

", "DescribeJobQueuesRequest$jobQueues": "

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

", @@ -924,7 +924,7 @@ } }, "SubmitJobRequest": { - "base": null, + "base": "

Contains the parameters for SubmitJob.

", "refs": { } }, @@ -967,10 +967,10 @@ "refs": { "ComputeEnvironmentDetail$tags": "

The tags applied to the compute environment.

", "CreateComputeEnvironmentRequest$tags": "

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

", - "CreateJobQueueRequest$tags": "

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

", + "CreateJobQueueRequest$tags": "

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.

", "JobDefinition$tags": "

The tags applied to the job definition.

", "JobDetail$tags": "

The tags applied to the job.

", - "JobQueueDetail$tags": "

The tags applied to the job queue.

", + "JobQueueDetail$tags": "

The tags applied to the job queue. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide.

", "ListTagsForResourceResponse$tags": "

The tags for the resource.

", "RegisterJobDefinitionRequest$tags": "

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.

", "SubmitJobRequest$tags": "

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

", @@ -980,11 +980,11 @@ "TagsMap": { "base": null, "refs": { - "ComputeResource$tags": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value—for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.

" + "ComputeResource$tags": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

" } }, "TerminateJobRequest": { - "base": null, + "base": "

Contains the parameters for TerminateJob.

", "refs": { } }, @@ -1029,7 +1029,7 @@ } }, "UpdateComputeEnvironmentRequest": { - "base": null, + "base": "

Contains the parameters for UpdateComputeEnvironment.

", "refs": { } }, @@ -1039,7 +1039,7 @@ } }, "UpdateJobQueueRequest": { - "base": null, + "base": "

Contains the parameters for UpdateJobQueue.

", "refs": { } }, diff --git a/models/apis/config/2014-11-12/api-2.json b/models/apis/config/2014-11-12/api-2.json index 8697fc21336..c5b452631cd 100644 --- a/models/apis/config/2014-11-12/api-2.json +++ b/models/apis/config/2014-11-12/api-2.json @@ -208,6 +208,19 @@ {"shape":"NoSuchRetentionConfigurationException"} ] }, + "DeleteStoredQuery":{ + "name":"DeleteStoredQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStoredQueryRequest"}, + "output":{"shape":"DeleteStoredQueryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "DeliverConfigSnapshot":{ "name":"DeliverConfigSnapshot", "http":{ @@ -748,6 +761,19 @@ {"shape":"ResourceNotDiscoveredException"} ] }, + "GetStoredQuery":{ + "name":"GetStoredQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetStoredQueryRequest"}, + "output":{"shape":"GetStoredQueryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "ListAggregateDiscoveredResources":{ "name":"ListAggregateDiscoveredResources", "http":{ @@ -778,6 +804,19 @@ {"shape":"NoAvailableConfigurationRecorderException"} ] }, + "ListStoredQueries":{ + "name":"ListStoredQueries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStoredQueriesRequest"}, + "output":{"shape":"ListStoredQueriesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"} + ] + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -1002,6 +1041,20 @@ {"shape":"MaxNumberOfRetentionConfigurationsExceededException"} ] }, + "PutStoredQuery":{ + "name":"PutStoredQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutStoredQueryRequest"}, + "output":{"shape":"PutStoredQueryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ResourceConcurrentModificationException"} + ] + }, "SelectAggregateResourceConfig":{ "name":"SelectAggregateResourceConfig", "http":{ @@ -1982,6 +2035,18 @@ "RetentionConfigurationName":{"shape":"RetentionConfigurationName"} } }, + "DeleteStoredQueryRequest":{ + "type":"structure", + "required":["QueryName"], + "members":{ + "QueryName":{"shape":"QueryName"} + } + }, + "DeleteStoredQueryResponse":{ + "type":"structure", + "members":{ + } + }, "DeliverConfigSnapshotRequest":{ "type":"structure", "required":["deliveryChannelName"], @@ -2423,6 +2488,7 @@ "max":256, "min":0 }, + "ErrorMessage":{"type":"string"}, "Evaluation":{ "type":"structure", "required":[ @@ -2806,6 +2872,19 @@ "nextToken":{"shape":"NextToken"} } }, + "GetStoredQueryRequest":{ + "type":"structure", + "required":["QueryName"], + "members":{ + "QueryName":{"shape":"QueryName"} + } + }, + "GetStoredQueryResponse":{ + "type":"structure", + "members":{ + "StoredQuery":{"shape":"StoredQuery"} + } + }, "GroupByAPILimit":{ "type":"integer", "max":1000, @@ -2970,6 +3049,26 @@ "nextToken":{"shape":"NextToken"} } }, + "ListStoredQueriesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "box":true + }, + "MaxResults":{ + "shape":"Limit", + "box":true + } + } + }, + "ListStoredQueriesResponse":{ + "type":"structure", + "members":{ + "StoredQueryMetadata":{"shape":"StoredQueryMetadataList"}, + "NextToken":{"shape":"String"} + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], @@ -3674,12 +3773,56 @@ "RetentionConfiguration":{"shape":"RetentionConfiguration"} } }, + "PutStoredQueryRequest":{ + "type":"structure", + "required":["StoredQuery"], + "members":{ + "StoredQuery":{"shape":"StoredQuery"}, + "Tags":{"shape":"TagsList"} + } + }, + "PutStoredQueryResponse":{ + "type":"structure", + "members":{ + "QueryArn":{"shape":"QueryArn"} + } + }, + "QueryArn":{ + "type":"string", + "max":500, + "min":1, + "pattern":"^arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:stored-query/[a-zA-Z0-9-_]+/query-[a-zA-Z\\d-_/]+$" + }, + "QueryDescription":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[\\s\\S]*" + }, + "QueryExpression":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"[\\s\\S]*" + }, + "QueryId":{ + "type":"string", + "max":36, + "min":1, + "pattern":"^\\S+$" + }, "QueryInfo":{ "type":"structure", "members":{ "SelectFields":{"shape":"FieldInfoList"} } }, + "QueryName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, "RecorderName":{ "type":"string", "max":256, @@ -3857,6 +4000,13 @@ "type":"string", "enum":["SSM_DOCUMENT"] }, + "ResourceConcurrentModificationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, "ResourceCount":{ "type":"structure", "members":{ @@ -4027,6 +4177,9 @@ "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", + "AWS::NetworkFirewall::Firewall", + "AWS::NetworkFirewall::FirewallPolicy", + "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", @@ -4285,6 +4438,47 @@ "ConfigurationRecorderName":{"shape":"RecorderName"} } }, + "StoredQuery":{ + "type":"structure", + "required":["QueryName"], + "members":{ + "QueryId":{ + "shape":"QueryId", + "box":true + }, + "QueryArn":{ + "shape":"QueryArn", + "box":true + }, + "QueryName":{"shape":"QueryName"}, + "Description":{ + "shape":"QueryDescription", + "box":true + }, + "Expression":{ + "shape":"QueryExpression", + "box":true + } + } + }, + "StoredQueryMetadata":{ + "type":"structure", + "required":[ + "QueryId", + "QueryArn", + "QueryName" + ], + "members":{ + "QueryId":{"shape":"QueryId"}, + "QueryArn":{"shape":"QueryArn"}, + "QueryName":{"shape":"QueryName"}, + "Description":{"shape":"QueryDescription"} + } + }, + "StoredQueryMetadataList":{ + "type":"list", + "member":{"shape":"StoredQueryMetadata"} + }, "String":{"type":"string"}, "StringWithCharLimit1024":{ "type":"string", diff --git a/models/apis/config/2014-11-12/docs-2.json b/models/apis/config/2014-11-12/docs-2.json index ca3ab59ecec..11ef25f3b4a 100644 --- a/models/apis/config/2014-11-12/docs-2.json +++ b/models/apis/config/2014-11-12/docs-2.json @@ -18,6 +18,7 @@ "DeleteRemediationExceptions": "

Deletes one or more remediation exceptions mentioned in the resource keys.

AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

", "DeleteResourceConfig": "

Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your AWS Config History.

", "DeleteRetentionConfiguration": "

Deletes the retention configuration.

", + "DeleteStoredQuery": "

Deletes the stored query for an AWS account in an AWS Region.

", "DeliverConfigSnapshot": "

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified.

", "DescribeAggregateComplianceByConfigRules": "

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

", "DescribeAggregationAuthorizations": "

Returns a list of authorizations granted to various aggregator accounts and regions.

", @@ -57,8 +58,10 @@ "GetOrganizationConfigRuleDetailedStatus": "

Returns detailed status for each member account within an organization for a given organization config rule.

", "GetOrganizationConformancePackDetailedStatus": "

Returns detailed status for each member account within an organization for a given organization conformance pack.

", "GetResourceConfigHistory": "

Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config returns the ConfigurationItems for the specified retention period.

The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

", + "GetStoredQuery": "

Returns the details of a specific stored query.

", "ListAggregateDiscoveredResources": "

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.

For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.

", "ListDiscoveredResources": "

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

You can specify either resource IDs or a resource name, but not both, in the same request.

The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

", + "ListStoredQueries": "

List the stored queries for an AWS account in an AWS Region. The default is 100.

", "ListTagsForResource": "

List the tags for AWS Config resource.

", "PutAggregationAuthorization": "

Authorizes the aggregator account and region to collect data from the source account and region.

", "PutConfigRule": "

Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.

You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.

If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules.

For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

The maximum number of rules that AWS Config supports is 150.

For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

", @@ -71,9 +74,10 @@ "PutOrganizationConfigRule": "

Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations.

Only a master account and a delegated administrator can create or update an organization config rule. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added.

This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. AWS Config verifies the existence of role with GetRole action.

To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com.

You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. When you use the PutOrganizationConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the RuleIdentifier key.

The maximum number of organization config rules that AWS Config supports is 150 and 3 delegated administrator per organization.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.

", "PutOrganizationConformancePack": "

Deploys conformance packs across member accounts in an AWS Organization.

Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added.

This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

AWS Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.

You can create 6 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.

", "PutRemediationConfigurations": "

Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.

If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.

This API does not support adding remediation configurations for service-linked AWS Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by AWS Security Hub.

", - "PutRemediationExceptions": "

A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific AWS Config rule.

AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

", + "PutRemediationExceptions": "

A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule.

AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

", "PutResourceConfig": "

Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in AWS Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing AWS Config APIs.

The custom resource type must be registered with AWS CloudFormation. This API accepts the configuration item registered with AWS CloudFormation.

When you call this API, AWS Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.

", "PutRetentionConfiguration": "

Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.

Currently, AWS Config supports only one retention configuration per region in your account.

", + "PutStoredQuery": "

Saves a new query or updates an existing saved query. The QueryName must be unique for an AWS account in an AWS Region. You can create upto 300 queries in an AWS account in an AWS Region.

", "SelectAggregateResourceConfig": "

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of AWS resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the AWS Config Developer Guide.

", "SelectResourceConfig": "

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the AWS Config Developer Guide.

", "StartConfigRulesEvaluation": "

Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.

You can specify up to 25 AWS Config rules per request.

An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. AWS Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

", @@ -88,7 +92,7 @@ "base": null, "refs": { "BaseConfigurationItem$arn": "

The Amazon Resource Name (ARN) of the resource.

", - "ConfigurationItem$arn": "

Amazon Resource Name (ARN) associated with the resource.

" + "ConfigurationItem$arn": "

accoun

" } }, "AccountAggregationSource": { @@ -989,6 +993,16 @@ "refs": { } }, + "DeleteStoredQueryRequest": { + "base": null, + "refs": { + } + }, + "DeleteStoredQueryResponse": { + "base": null, + "refs": { + } + }, "DeliverConfigSnapshotRequest": { "base": "

The input for the DeliverConfigSnapshot action.

", "refs": { @@ -1034,19 +1048,19 @@ "DeliveryS3Bucket": { "base": null, "refs": { - "ConformancePackDetail$DeliveryS3Bucket": "

Amazon S3 bucket where AWS Config stores conformance pack templates.

This field is optional.

", - "OrganizationConformancePack$DeliveryS3Bucket": "

Amazon S3 bucket where AWS Config stores conformance pack templates.

This field is optional.

", - "PutConformancePackRequest$DeliveryS3Bucket": "

Amazon S3 bucket where AWS Config stores conformance pack templates.

This field is optional.

", - "PutOrganizationConformancePackRequest$DeliveryS3Bucket": "

Amazon S3 bucket where AWS Config stores conformance pack templates.

This field is optional.

" + "ConformancePackDetail$DeliveryS3Bucket": "

Conformance pack template that is used to create a pack. The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\".

", + "OrganizationConformancePack$DeliveryS3Bucket": "

Location of an Amazon S3 bucket where AWS Config can deliver evaluation results and conformance pack template that is used to create a pack.

", + "PutConformancePackRequest$DeliveryS3Bucket": "

AWS Config stores intermediate files while processing conformance pack template.

", + "PutOrganizationConformancePackRequest$DeliveryS3Bucket": "

Location of an Amazon S3 bucket where AWS Config can deliver evaluation results. AWS Config stores intermediate files while processing conformance pack template.

The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\". For more information, see Permissions for cross account bucket access.

" } }, "DeliveryS3KeyPrefix": { "base": null, "refs": { - "ConformancePackDetail$DeliveryS3KeyPrefix": "

The prefix for the Amazon S3 bucket.

This field is optional.

", - "OrganizationConformancePack$DeliveryS3KeyPrefix": "

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

", - "PutConformancePackRequest$DeliveryS3KeyPrefix": "

The prefix for the Amazon S3 bucket.

This field is optional.

", - "PutOrganizationConformancePackRequest$DeliveryS3KeyPrefix": "

The prefix for the Amazon S3 bucket.

This field is optional.

" + "ConformancePackDetail$DeliveryS3KeyPrefix": "

The prefix for the Amazon S3 bucket.

", + "OrganizationConformancePack$DeliveryS3KeyPrefix": "

Any folder structure you want to add to an Amazon S3 bucket.

", + "PutConformancePackRequest$DeliveryS3KeyPrefix": "

The prefix for the Amazon S3 bucket.

", + "PutOrganizationConformancePackRequest$DeliveryS3KeyPrefix": "

The prefix for the Amazon S3 bucket.

" } }, "DeliveryStatus": { @@ -1326,6 +1340,12 @@ "ConfigRule$Description": "

The description that you provide for the AWS Config rule.

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

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

", "refs": { @@ -1595,6 +1615,16 @@ "refs": { } }, + "GetStoredQueryRequest": { + "base": null, + "refs": { + } + }, + "GetStoredQueryResponse": { + "base": null, + "refs": { + } + }, "GroupByAPILimit": { "base": null, "refs": { @@ -1721,8 +1751,9 @@ "GetComplianceDetailsByConfigRuleRequest$Limit": "

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

", "GetDiscoveredResourceCountsRequest$limit": "

The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

", "GetResourceConfigHistoryRequest$limit": "

The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

", - "ListAggregateDiscoveredResourcesRequest$Limit": "

The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

", + "ListAggregateDiscoveredResourcesRequest$Limit": "

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

", "ListDiscoveredResourcesRequest$limit": "

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

", + "ListStoredQueriesRequest$MaxResults": "

The maximum number of results to be returned with a single call.

", "ListTagsForResourceRequest$Limit": "

The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default.

", "SelectAggregateResourceConfigRequest$Limit": "

The maximum number of query results returned on each page.

", "SelectAggregateResourceConfigRequest$MaxResults": "

The maximum number of query results returned on each page. AWS Config also allows the Limit request parameter.

", @@ -1754,6 +1785,16 @@ "refs": { } }, + "ListStoredQueriesRequest": { + "base": null, + "refs": { + } + }, + "ListStoredQueriesResponse": { + "base": null, + "refs": { + } + }, "ListTagsForResourceRequest": { "base": null, "refs": { @@ -2322,6 +2363,44 @@ "refs": { } }, + "PutStoredQueryRequest": { + "base": null, + "refs": { + } + }, + "PutStoredQueryResponse": { + "base": null, + "refs": { + } + }, + "QueryArn": { + "base": null, + "refs": { + "PutStoredQueryResponse$QueryArn": "

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id.

", + "StoredQuery$QueryArn": "

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id.

", + "StoredQueryMetadata$QueryArn": "

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id.

" + } + }, + "QueryDescription": { + "base": null, + "refs": { + "StoredQuery$Description": "

A unique description for the query.

", + "StoredQueryMetadata$Description": "

A unique description for the query.

" + } + }, + "QueryExpression": { + "base": null, + "refs": { + "StoredQuery$Expression": "

The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.

" + } + }, + "QueryId": { + "base": null, + "refs": { + "StoredQuery$QueryId": "

The ID of the query.

", + "StoredQueryMetadata$QueryId": "

The ID of the query.

" + } + }, "QueryInfo": { "base": "

Details about the query.

", "refs": { @@ -2329,6 +2408,15 @@ "SelectResourceConfigResponse$QueryInfo": "

Returns the QueryInfo object.

" } }, + "QueryName": { + "base": null, + "refs": { + "DeleteStoredQueryRequest$QueryName": "

The name of the query that you want to delete.

", + "GetStoredQueryRequest$QueryName": "

The name of the query.

", + "StoredQuery$QueryName": "

The name of the query.

", + "StoredQueryMetadata$QueryName": "

The name of the query.

" + } + }, "RecorderName": { "base": null, "refs": { @@ -2488,6 +2576,11 @@ "RemediationConfiguration$TargetType": "

The type of the target. Target executes remediation. For example, SSM document.

" } }, + "ResourceConcurrentModificationException": { + "base": "

Two users are trying to modify the same query at the same time. Wait for a moment and try again.

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

An object that contains the resource type and the number of resources.

", "refs": { @@ -2829,6 +2922,25 @@ "refs": { } }, + "StoredQuery": { + "base": "

Provides the details of a stored query.

", + "refs": { + "GetStoredQueryResponse$StoredQuery": "

Returns a StoredQuery object.

", + "PutStoredQueryRequest$StoredQuery": "

A list of StoredQuery objects. The mandatory fields are QueryName and Expression.

" + } + }, + "StoredQueryMetadata": { + "base": "

Returns details of a specific query.

", + "refs": { + "StoredQueryMetadataList$member": null + } + }, + "StoredQueryMetadataList": { + "base": null, + "refs": { + "ListStoredQueriesResponse$StoredQueryMetadata": "

A list of StoredQueryMetadata objects.

" + } + }, "String": { "base": null, "refs": { @@ -2891,6 +3003,8 @@ "GetOrganizationConfigRuleDetailedStatusResponse$NextToken": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

", "GetOrganizationConformancePackDetailedStatusRequest$NextToken": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

", "GetOrganizationConformancePackDetailedStatusResponse$NextToken": "

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

", + "ListStoredQueriesRequest$NextToken": "

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

", + "ListStoredQueriesResponse$NextToken": "

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

", "MemberAccountStatus$ErrorCode": "

An error code that is returned when config rule creation or deletion failed in the member account.

", "MemberAccountStatus$ErrorMessage": "

An error message indicating that config rule account creation or deletion has failed due to an error in the member account.

", "OrganizationAggregationSource$RoleArn": "

ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account.

", @@ -3076,7 +3190,8 @@ "refs": { "PutAggregationAuthorizationRequest$Tags": "

An array of tag object.

", "PutConfigRuleRequest$Tags": "

An array of tag object.

", - "PutConfigurationAggregatorRequest$Tags": "

An array of tag object.

" + "PutConfigurationAggregatorRequest$Tags": "

An array of tag object.

", + "PutStoredQueryRequest$Tags": "

A list of Tags object.

" } }, "TemplateBody": { diff --git a/models/apis/config/2014-11-12/paginators-1.json b/models/apis/config/2014-11-12/paginators-1.json index c7b61c50847..008eb9ebe29 100644 --- a/models/apis/config/2014-11-12/paginators-1.json +++ b/models/apis/config/2014-11-12/paginators-1.json @@ -17,6 +17,11 @@ "output_token": "nextToken", "result_key": "configurationItems" }, + "ListStoredQueries": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken" + }, "SelectAggregateResourceConfig": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/models/apis/connectparticipant/2018-09-07/api-2.json b/models/apis/connectparticipant/2018-09-07/api-2.json index 388a41d64a0..e0b763ea948 100644 --- a/models/apis/connectparticipant/2018-09-07/api-2.json +++ b/models/apis/connectparticipant/2018-09-07/api-2.json @@ -13,6 +13,23 @@ "uid":"connectparticipant-2018-09-07" }, "operations":{ + "CompleteAttachmentUpload":{ + "name":"CompleteAttachmentUpload", + "http":{ + "method":"POST", + "requestUri":"/participant/complete-attachment-upload" + }, + "input":{"shape":"CompleteAttachmentUploadRequest"}, + "output":{"shape":"CompleteAttachmentUploadResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"} + ] + }, "CreateParticipantConnection":{ "name":"CreateParticipantConnection", "http":{ @@ -43,6 +60,21 @@ {"shape":"ValidationException"} ] }, + "GetAttachment":{ + "name":"GetAttachment", + "http":{ + "method":"POST", + "requestUri":"/participant/attachment" + }, + "input":{"shape":"GetAttachmentRequest"}, + "output":{"shape":"GetAttachmentResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] + }, "GetTranscript":{ "name":"GetTranscript", "http":{ @@ -87,6 +119,22 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ] + }, + "StartAttachmentUpload":{ + "name":"StartAttachmentUpload", + "http":{ + "method":"POST", + "requestUri":"/participant/start-attachment-upload" + }, + "input":{"shape":"StartAttachmentUploadRequest"}, + "output":{"shape":"StartAttachmentUploadResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ] } }, "shapes":{ @@ -99,6 +147,47 @@ "error":{"httpStatusCode":403}, "exception":true }, + "ArtifactId":{ + "type":"string", + "max":256, + "min":1 + }, + "ArtifactStatus":{ + "type":"string", + "enum":[ + "APPROVED", + "REJECTED", + "IN_PROGRESS" + ] + }, + "AttachmentIdList":{ + "type":"list", + "member":{"shape":"ArtifactId"}, + "max":1, + "min":1 + }, + "AttachmentItem":{ + "type":"structure", + "members":{ + "ContentType":{"shape":"ContentType"}, + "AttachmentId":{"shape":"ArtifactId"}, + "AttachmentName":{"shape":"AttachmentName"}, + "Status":{"shape":"ArtifactStatus"} + } + }, + "AttachmentName":{ + "type":"string", + "max":256, + "min":1 + }, + "AttachmentSizeInBytes":{ + "type":"long", + "min":1 + }, + "Attachments":{ + "type":"list", + "member":{"shape":"AttachmentItem"} + }, "ChatContent":{ "type":"string", "max":1024, @@ -117,8 +206,15 @@ "ChatItemType":{ "type":"string", "enum":[ + "TYPING", + "PARTICIPANT_JOINED", + "PARTICIPANT_LEFT", + "CHAT_ENDED", + "TRANSFER_SUCCEEDED", + "TRANSFER_FAILED", "MESSAGE", "EVENT", + "ATTACHMENT", "CONNECTION_ACK" ] }, @@ -126,6 +222,40 @@ "type":"string", "max":500 }, + "CompleteAttachmentUploadRequest":{ + "type":"structure", + "required":[ + "AttachmentIds", + "ClientToken", + "ConnectionToken" + ], + "members":{ + "AttachmentIds":{"shape":"AttachmentIdList"}, + "ClientToken":{ + "shape":"NonEmptyClientToken", + "idempotencyToken":true + }, + "ConnectionToken":{ + "shape":"ParticipantToken", + "location":"header", + "locationName":"X-Amz-Bearer" + } + } + }, + "CompleteAttachmentUploadResponse":{ + "type":"structure", + "members":{ + } + }, + "ConflictException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"Reason"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, "ConnectionCredentials":{ "type":"structure", "members":{ @@ -150,6 +280,11 @@ "max":256, "min":1 }, + "ContentType":{ + "type":"string", + "max":255, + "min":1 + }, "CreateParticipantConnectionRequest":{ "type":"structure", "required":[ @@ -197,6 +332,28 @@ "max":256, "min":1 }, + "GetAttachmentRequest":{ + "type":"structure", + "required":[ + "AttachmentId", + "ConnectionToken" + ], + "members":{ + "AttachmentId":{"shape":"ArtifactId"}, + "ConnectionToken":{ + "shape":"ParticipantToken", + "location":"header", + "locationName":"X-Amz-Bearer" + } + } + }, + "GetAttachmentResponse":{ + "type":"structure", + "members":{ + "Url":{"shape":"PreSignedAttachmentUrl"}, + "UrlExpiry":{"shape":"ISO8601Datetime"} + } + }, "GetTranscriptRequest":{ "type":"structure", "required":["ConnectionToken"], @@ -251,7 +408,8 @@ "Type":{"shape":"ChatItemType"}, "ParticipantId":{"shape":"ParticipantId"}, "DisplayName":{"shape":"DisplayName"}, - "ParticipantRole":{"shape":"ParticipantRole"} + "ParticipantRole":{"shape":"ParticipantRole"}, + "Attachments":{"shape":"Attachments"} } }, "MaxResults":{ @@ -270,6 +428,11 @@ "max":1000, "min":1 }, + "NonEmptyClientToken":{ + "type":"string", + "max":500, + "min":1 + }, "ParticipantId":{ "type":"string", "max":256, @@ -288,6 +451,11 @@ "max":1000, "min":1 }, + "PreSignedAttachmentUrl":{ + "type":"string", + "max":2000, + "min":1 + }, "PreSignedConnectionUrl":{ "type":"string", "max":2000, @@ -360,6 +528,15 @@ "AbsoluteTime":{"shape":"Instant"} } }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"Message"} + }, + "error":{"httpStatusCode":402}, + "exception":true + }, "SortKey":{ "type":"string", "enum":[ @@ -367,6 +544,37 @@ "ASCENDING" ] }, + "StartAttachmentUploadRequest":{ + "type":"structure", + "required":[ + "ContentType", + "AttachmentSizeInBytes", + "AttachmentName", + "ClientToken", + "ConnectionToken" + ], + "members":{ + "ContentType":{"shape":"ContentType"}, + "AttachmentSizeInBytes":{"shape":"AttachmentSizeInBytes"}, + "AttachmentName":{"shape":"AttachmentName"}, + "ClientToken":{ + "shape":"NonEmptyClientToken", + "idempotencyToken":true + }, + "ConnectionToken":{ + "shape":"ParticipantToken", + "location":"header", + "locationName":"X-Amz-Bearer" + } + } + }, + "StartAttachmentUploadResponse":{ + "type":"structure", + "members":{ + "AttachmentId":{"shape":"ArtifactId"}, + "UploadMetadata":{"shape":"UploadMetadata"} + } + }, "StartPosition":{ "type":"structure", "members":{ @@ -388,6 +596,34 @@ "type":"list", "member":{"shape":"Item"} }, + "UploadMetadata":{ + "type":"structure", + "members":{ + "Url":{"shape":"UploadMetadataUrl"}, + "UrlExpiry":{"shape":"ISO8601Datetime"}, + "HeadersToInclude":{"shape":"UploadMetadataSignedHeaders"} + } + }, + "UploadMetadataSignedHeaders":{ + "type":"map", + "key":{"shape":"UploadMetadataSignedHeadersKey"}, + "value":{"shape":"UploadMetadataSignedHeadersValue"} + }, + "UploadMetadataSignedHeadersKey":{ + "type":"string", + "max":128, + "min":1 + }, + "UploadMetadataSignedHeadersValue":{ + "type":"string", + "max":256, + "min":1 + }, + "UploadMetadataUrl":{ + "type":"string", + "max":2000, + "min":1 + }, "ValidationException":{ "type":"structure", "required":["Message"], diff --git a/models/apis/connectparticipant/2018-09-07/docs-2.json b/models/apis/connectparticipant/2018-09-07/docs-2.json index f47c23e463f..5758bed5ef3 100644 --- a/models/apis/connectparticipant/2018-09-07/docs-2.json +++ b/models/apis/connectparticipant/2018-09-07/docs-2.json @@ -2,11 +2,14 @@ "version": "2.0", "service": "

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect enables customer contacts through voice or chat.

The APIs described here are used by chat participants, such as agents and customers.

", "operations": { - "CreateParticipantConnection": "

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until the they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

", - "DisconnectParticipant": "

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

", - "GetTranscript": "

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

", - "SendEvent": "

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

", - "SendMessage": "

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

" + "CompleteAttachmentUpload": "

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

", + "CreateParticipantConnection": "

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

", + "DisconnectParticipant": "

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

", + "GetAttachment": "

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

", + "GetTranscript": "

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

", + "SendEvent": "

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

", + "SendMessage": "

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

", + "StartAttachmentUpload": "

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

" }, "shapes": { "AccessDeniedException": { @@ -14,6 +17,52 @@ "refs": { } }, + "ArtifactId": { + "base": null, + "refs": { + "AttachmentIdList$member": null, + "AttachmentItem$AttachmentId": "

A unique identifier for the attachment.

", + "GetAttachmentRequest$AttachmentId": "

A unique identifier for the attachment.

", + "StartAttachmentUploadResponse$AttachmentId": "

A unique identifier for the attachment.

" + } + }, + "ArtifactStatus": { + "base": null, + "refs": { + "AttachmentItem$Status": "

Status of the attachment.

" + } + }, + "AttachmentIdList": { + "base": null, + "refs": { + "CompleteAttachmentUploadRequest$AttachmentIds": "

A list of unique identifiers for the attachments.

" + } + }, + "AttachmentItem": { + "base": "

The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.

", + "refs": { + "Attachments$member": null + } + }, + "AttachmentName": { + "base": null, + "refs": { + "AttachmentItem$AttachmentName": "

A case-sensitive name of the attachment being uploaded.

", + "StartAttachmentUploadRequest$AttachmentName": "

A case-sensitive name of the attachment being uploaded.

" + } + }, + "AttachmentSizeInBytes": { + "base": null, + "refs": { + "StartAttachmentUploadRequest$AttachmentSizeInBytes": "

The size of the attachment in bytes.

" + } + }, + "Attachments": { + "base": null, + "refs": { + "Item$Attachments": "

Provides information about the attachments.

" + } + }, "ChatContent": { "base": null, "refs": { @@ -53,6 +102,21 @@ "SendMessageRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" } }, + "CompleteAttachmentUploadRequest": { + "base": null, + "refs": { + } + }, + "CompleteAttachmentUploadResponse": { + "base": null, + "refs": { + } + }, + "ConflictException": { + "base": "

An attachment with that identifier is already being uploaded.

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

Connection credentials.

", "refs": { @@ -78,6 +142,13 @@ "GetTranscriptResponse$InitialContactId": "

The initial contact ID for the contact.

" } }, + "ContentType": { + "base": null, + "refs": { + "AttachmentItem$ContentType": "

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

", + "StartAttachmentUploadRequest$ContentType": "

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

" + } + }, "CreateParticipantConnectionRequest": { "base": null, "refs": { @@ -104,6 +175,16 @@ "Item$DisplayName": "

The chat display name of the sender.

" } }, + "GetAttachmentRequest": { + "base": null, + "refs": { + } + }, + "GetAttachmentResponse": { + "base": null, + "refs": { + } + }, "GetTranscriptRequest": { "base": null, "refs": { @@ -118,6 +199,8 @@ "base": null, "refs": { "ConnectionCredentials$Expiry": "

The expiration of the token.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

", + "GetAttachmentResponse$UrlExpiry": "

The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

", + "UploadMetadata$UrlExpiry": "

The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

", "Websocket$ConnectionExpiry": "

The URL expiration timestamp in ISO date format.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

" } }, @@ -152,6 +235,7 @@ "refs": { "AccessDeniedException$Message": null, "InternalServerException$Message": null, + "ServiceQuotaExceededException$Message": null, "ThrottlingException$Message": null } }, @@ -168,6 +252,13 @@ "GetTranscriptResponse$NextToken": "

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

" } }, + "NonEmptyClientToken": { + "base": null, + "refs": { + "CompleteAttachmentUploadRequest$ClientToken": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "StartAttachmentUploadRequest$ClientToken": "

A unique case sensitive identifier to support idempotency of request.

" + } + }, "ParticipantId": { "base": null, "refs": { @@ -183,12 +274,21 @@ "ParticipantToken": { "base": null, "refs": { + "CompleteAttachmentUploadRequest$ConnectionToken": "

The authentication token associated with the participant's connection.

", "ConnectionCredentials$ConnectionToken": "

The connection token.

", - "CreateParticipantConnectionRequest$ParticipantToken": "

Participant Token as obtained from StartChatContact API response.

", + "CreateParticipantConnectionRequest$ParticipantToken": "

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

", "DisconnectParticipantRequest$ConnectionToken": "

The authentication token associated with the participant's connection.

", + "GetAttachmentRequest$ConnectionToken": "

The authentication token associated with the participant's connection.

", "GetTranscriptRequest$ConnectionToken": "

The authentication token associated with the participant's connection.

", "SendEventRequest$ConnectionToken": "

The authentication token associated with the participant's connection.

", - "SendMessageRequest$ConnectionToken": "

The authentication token associated with the connection.

" + "SendMessageRequest$ConnectionToken": "

The authentication token associated with the connection.

", + "StartAttachmentUploadRequest$ConnectionToken": "

The authentication token associated with the participant's connection.

" + } + }, + "PreSignedAttachmentUrl": { + "base": null, + "refs": { + "GetAttachmentResponse$Url": "

The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.

" } }, "PreSignedConnectionUrl": { @@ -200,6 +300,7 @@ "Reason": { "base": null, "refs": { + "ConflictException$Message": null, "ValidationException$Message": null } }, @@ -229,12 +330,27 @@ "refs": { } }, + "ServiceQuotaExceededException": { + "base": "

The number of attachments per contact exceeds the quota.

", + "refs": { + } + }, "SortKey": { "base": null, "refs": { "GetTranscriptRequest$SortOrder": "

The sort order for the records. Default: DESCENDING.

" } }, + "StartAttachmentUploadRequest": { + "base": null, + "refs": { + } + }, + "StartAttachmentUploadResponse": { + "base": null, + "refs": { + } + }, "StartPosition": { "base": "

A filtering option for where to start. For example, if you sent 100 messages, start with message 50.

", "refs": { @@ -252,6 +368,36 @@ "GetTranscriptResponse$Transcript": "

The list of messages in the session.

" } }, + "UploadMetadata": { + "base": "

Fields to be used while uploading the attachment.

", + "refs": { + "StartAttachmentUploadResponse$UploadMetadata": "

Fields to be used while uploading the attachment.

" + } + }, + "UploadMetadataSignedHeaders": { + "base": null, + "refs": { + "UploadMetadata$HeadersToInclude": "

The headers to be provided while uploading the file to the URL.

" + } + }, + "UploadMetadataSignedHeadersKey": { + "base": null, + "refs": { + "UploadMetadataSignedHeaders$key": null + } + }, + "UploadMetadataSignedHeadersValue": { + "base": null, + "refs": { + "UploadMetadataSignedHeaders$value": null + } + }, + "UploadMetadataUrl": { + "base": null, + "refs": { + "UploadMetadata$Url": "

The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.

" + } + }, "ValidationException": { "base": "

The input fails to satisfy the constraints specified by Amazon Connect.

", "refs": { diff --git a/models/apis/dms/2016-01-01/api-2.json b/models/apis/dms/2016-01-01/api-2.json index 8b8aa233ef3..5f7e9a4c49f 100644 --- a/models/apis/dms/2016-01-01/api-2.json +++ b/models/apis/dms/2016-01-01/api-2.json @@ -1535,7 +1535,9 @@ "NestingLevel":{"shape":"NestingLevelValue"}, "ExtractDocId":{"shape":"BooleanOptional"}, "DocsToInvestigate":{"shape":"IntegerOptional"}, - "KmsKeyId":{"shape":"String"} + "KmsKeyId":{"shape":"String"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "DynamoDbSettings":{ @@ -1696,7 +1698,9 @@ "SetDataCaptureChanges":{"shape":"BooleanOptional"}, "CurrentLsn":{"shape":"String"}, "MaxKBytesPerRead":{"shape":"IntegerOptional"}, - "Username":{"shape":"String"} + "Username":{"shape":"String"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "ImportCertificateMessage":{ @@ -1868,7 +1872,9 @@ "SafeguardPolicy":{"shape":"SafeguardPolicy"}, "ServerName":{"shape":"String"}, "Username":{"shape":"String"}, - "UseBcpFullLoad":{"shape":"BooleanOptional"} + "UseBcpFullLoad":{"shape":"BooleanOptional"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "MigrationTypeValue":{ @@ -2014,7 +2020,9 @@ "ExtractDocId":{"shape":"String"}, "DocsToInvestigate":{"shape":"String"}, "AuthSource":{"shape":"String"}, - "KmsKeyId":{"shape":"String"} + "KmsKeyId":{"shape":"String"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "MoveReplicationTaskMessage":{ @@ -2047,7 +2055,9 @@ "Port":{"shape":"IntegerOptional"}, "ServerName":{"shape":"String"}, "ServerTimezone":{"shape":"String"}, - "Username":{"shape":"String"} + "Username":{"shape":"String"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "NeptuneSettings":{ @@ -2105,7 +2115,9 @@ "SecurityDbEncryption":{"shape":"SecretString"}, "SecurityDbEncryptionName":{"shape":"String"}, "ServerName":{"shape":"String"}, - "Username":{"shape":"String"} + "Username":{"shape":"String"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "OrderableReplicationInstance":{ @@ -2166,7 +2178,9 @@ "Port":{"shape":"IntegerOptional"}, "ServerName":{"shape":"String"}, "Username":{"shape":"String"}, - "SlotName":{"shape":"String"} + "SlotName":{"shape":"String"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "RebootReplicationInstanceMessage":{ @@ -2213,7 +2227,9 @@ "TrimBlanks":{"shape":"BooleanOptional"}, "TruncateColumns":{"shape":"BooleanOptional"}, "Username":{"shape":"String"}, - "WriteBufferSize":{"shape":"IntegerOptional"} + "WriteBufferSize":{"shape":"IntegerOptional"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "RefreshSchemasMessage":{ @@ -2740,7 +2756,9 @@ "Password":{"shape":"SecretString"}, "Port":{"shape":"IntegerOptional"}, "ServerName":{"shape":"String"}, - "Username":{"shape":"String"} + "Username":{"shape":"String"}, + "SecretsManagerAccessRoleArn":{"shape":"String"}, + "SecretsManagerSecretId":{"shape":"String"} } }, "TStamp":{"type":"timestamp"}, diff --git a/models/apis/dms/2016-01-01/docs-2.json b/models/apis/dms/2016-01-01/docs-2.json index 2d01b99f8af..8fa2052e01d 100644 --- a/models/apis/dms/2016-01-01/docs-2.json +++ b/models/apis/dms/2016-01-01/docs-2.json @@ -157,7 +157,7 @@ "MicrosoftSQLServerSettings$UseBcpFullLoad": "

Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.

", "ModifyEventSubscriptionMessage$Enabled": "

A Boolean value; set to true to activate the subscription.

", "ModifyReplicationInstanceMessage$MultiAZ": "

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

", - "ModifyReplicationInstanceMessage$AutoMinorVersionUpgrade": "

A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case dsecribed following. The change is asynchronously applied as soon as possible.

An outage does result if these factors apply:

", + "ModifyReplicationInstanceMessage$AutoMinorVersionUpgrade": "

A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.

An outage does result if these factors apply:

", "NeptuneSettings$IamAuthEnabled": "

If you want AWS Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true. Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn. The default is false.

", "OracleSettings$AddSupplementalLogging": "

Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.

If you use this option, you still need to enable database-level supplemental logging.

", "OracleSettings$AllowSelectNestedTables": "

Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.

", @@ -188,8 +188,8 @@ "S3Settings$ParquetTimestampInMillisecond": "

A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.

AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.

When ParquetTimestampInMillisecond is set to true or y, AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.

Currently, Amazon Athena and AWS Glue can handle only millisecond precision for TIMESTAMP values. Set this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.

AWS DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond precision.

Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column value that is inserted by setting the TimestampColumnName parameter.

", "S3Settings$CdcInsertsAndUpdates": "

A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is false, but when CdcInsertsAndUpdates is set to true or y, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.

For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the IncludeOpForFullLoad parameter. If IncludeOpForFullLoad is set to true, the first field of every CDC record is set to either I or U to indicate INSERT and UPDATE operations at the source. But if IncludeOpForFullLoad is set to false, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide..

AWS DMS supports the use of the CdcInsertsAndUpdates parameter in versions 3.3.1 and later.

CdcInsertsOnly and CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not both.

", "S3Settings$DatePartitionEnabled": "

When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false. For more information about date-based folder partitoning, see Using date-based folder partitioning.

", - "S3Settings$UseCsvNoSupValue": "

This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue . If not set or set to false, AWS DMS uses the null value for these columns.

This setting is supported in AWS DMS versions 3.4.1 and later.

", - "S3Settings$PreserveTransactions": "

If set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath .

This setting is supported in AWS DMS versions 3.4.2 and later.

", + "S3Settings$UseCsvNoSupValue": "

This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue . If not set or set to false, AWS DMS uses the null value for these columns.

This setting is supported in AWS DMS versions 3.4.1 and later.

", + "S3Settings$PreserveTransactions": "

If set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath . For more information, see Capturing data changes (CDC) including transaction order on the S3 target.

This setting is supported in AWS DMS versions 3.4.2 and later.

", "TableStatistics$FullLoadReloaded": "

A value that indicates if the table was reloaded (true) or loaded as part of a new full load operation (false).

" } }, @@ -761,7 +761,7 @@ } }, "Filter": { - "base": "

Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter to the following APIs.

", + "base": "

Identifies the name and value of a filter object. This filter is used to limit the number and type of AWS DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

", "refs": { "FilterList$member": null } @@ -883,7 +883,7 @@ "MongoDbSettings$Port": "

The port value for the MongoDB source endpoint.

", "MySQLSettings$EventsPollInterval": "

Specifies how often to check the binary log for new changes/events when the database is idle.

Example: eventsPollInterval=5;

In the example, AWS DMS checks for changes in the binary logs every five seconds.

", "MySQLSettings$MaxFileSize": "

Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.

Example: maxFileSize=512

", - "MySQLSettings$ParallelLoadThreads": "

Improves performance when loading data into the MySQLcompatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread.

Example: parallelLoadThreads=1

", + "MySQLSettings$ParallelLoadThreads": "

Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread.

Example: parallelLoadThreads=1

", "MySQLSettings$Port": "

Endpoint TCP port.

", "NeptuneSettings$ErrorRetryDuration": "

The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.

", "NeptuneSettings$MaxFileSize": "

The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.

", @@ -1673,6 +1673,8 @@ "DocDbSettings$ServerName": "

The name of the server on the DocumentDB source endpoint.

", "DocDbSettings$DatabaseName": "

The database name on the DocumentDB source endpoint.

", "DocDbSettings$KmsKeyId": "

The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

", + "DocDbSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "DocDbSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the DocumentDB endpoint connection details.

", "DynamoDbSettings$ServiceAccessRoleArn": "

The Amazon Resource Name (ARN) used by the service access IAM role.

", "ElasticsearchSettings$ServiceAccessRoleArn": "

The Amazon Resource Name (ARN) used by service to access the IAM role.

", "ElasticsearchSettings$EndpointUri": "

The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.

", @@ -1707,6 +1709,8 @@ "IBMDb2Settings$ServerName": "

Fully qualified domain name of the endpoint.

", "IBMDb2Settings$CurrentLsn": "

For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.

", "IBMDb2Settings$Username": "

Endpoint connection user name.

", + "IBMDb2Settings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "IBMDb2Settings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.

", "ImportCertificateMessage$CertificateIdentifier": "

A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

", "ImportCertificateMessage$CertificatePem": "

The contents of a .pem file, which contains an X.509 certificate.

", "IncludeTestList$member": null, @@ -1718,9 +1722,11 @@ "KinesisSettings$ServiceAccessRoleArn": "

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.

", "ListTagsForResourceMessage$ResourceArn": "

The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.

", "MicrosoftSQLServerSettings$DatabaseName": "

Database name for the endpoint.

", - "MicrosoftSQLServerSettings$ControlTablesFileGroup": "

Specify a filegroup for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created on the specified filegroup.

", + "MicrosoftSQLServerSettings$ControlTablesFileGroup": "

Specifies a file group for the AWS DMS internal tables. When the replication task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.

", "MicrosoftSQLServerSettings$ServerName": "

Fully qualified domain name of the endpoint.

", "MicrosoftSQLServerSettings$Username": "

Endpoint connection user name.

", + "MicrosoftSQLServerSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "MicrosoftSQLServerSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.

", "ModifyEndpointMessage$EndpointArn": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", "ModifyEndpointMessage$EndpointIdentifier": "

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

", "ModifyEndpointMessage$EngineName": "

The type of engine for the endpoint. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".

", @@ -1755,6 +1761,8 @@ "MongoDbSettings$DocsToInvestigate": "

Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to \"one\".

Must be a positive value greater than 0. Default value is 1000.

", "MongoDbSettings$AuthSource": "

The MongoDB database name. This setting isn't used when AuthType is set to \"no\".

The default is \"admin\".

", "MongoDbSettings$KmsKeyId": "

The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

", + "MongoDbSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "MongoDbSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.

", "MoveReplicationTaskMessage$ReplicationTaskArn": "

The Amazon Resource Name (ARN) of the task that you want to move.

", "MoveReplicationTaskMessage$TargetReplicationInstanceArn": "

The ARN of the replication instance where you want to move the task to.

", "MySQLSettings$AfterConnectScript": "

Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.

", @@ -1762,6 +1770,8 @@ "MySQLSettings$ServerName": "

Fully qualified domain name of the endpoint.

", "MySQLSettings$ServerTimezone": "

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

", "MySQLSettings$Username": "

Endpoint connection user name.

", + "MySQLSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "MySQLSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.

", "NeptuneSettings$ServiceAccessRoleArn": "

The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.

", "NeptuneSettings$S3BucketName": "

The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.

", "NeptuneSettings$S3BucketFolder": "

A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName

", @@ -1773,6 +1783,8 @@ "OracleSettings$SecurityDbEncryptionName": "

For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for AWS DMS in the AWS Database Migration Service User Guide.

", "OracleSettings$ServerName": "

Fully qualified domain name of the endpoint.

", "OracleSettings$Username": "

Endpoint connection user name.

", + "OracleSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "OracleSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.

", "OrderableReplicationInstance$EngineVersion": "

The version of the replication engine.

", "OrderableReplicationInstance$ReplicationInstanceClass": "

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.

", "OrderableReplicationInstance$StorageType": "

The type of storage used by the replication instance.

", @@ -1785,9 +1797,11 @@ "PostgreSQLSettings$ServerName": "

Fully qualified domain name of the endpoint.

", "PostgreSQLSettings$Username": "

Endpoint connection user name.

", "PostgreSQLSettings$SlotName": "

Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance.

When used with the AWS DMS API CdcStartPosition request parameter, this attribute also enables using native CDC start points.

", + "PostgreSQLSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "PostgreSQLSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.

", "RebootReplicationInstanceMessage$ReplicationInstanceArn": "

The Amazon Resource Name (ARN) of the replication instance.

", "RedshiftSettings$AfterConnectScript": "

Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.

", - "RedshiftSettings$BucketFolder": "

An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.

For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS DMS uses the Redshift COPY command to upload the .csv files to the target table. The files are deleted once the COPY operation has finished. For more information, see Amazon Redshift Database Developer Guide

For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.

", + "RedshiftSettings$BucketFolder": "

An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.

For full load mode, AWS DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. AWS DMS uses the Redshift COPY command to upload the .csv files to the target table. The files are deleted once the COPY operation has finished. For more information, see COPY in the Amazon Redshift Database Developer Guide.

For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.

", "RedshiftSettings$BucketName": "

The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.

", "RedshiftSettings$DatabaseName": "

The name of the Amazon Redshift data warehouse (service) that you are working with.

", "RedshiftSettings$DateFormat": "

The date format that you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that aren't supported when you use a date format string.

If your date and time values use formats different from each other, set this to auto.

", @@ -1798,6 +1812,8 @@ "RedshiftSettings$ServerSideEncryptionKmsKeyId": "

The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.

", "RedshiftSettings$TimeFormat": "

The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that aren't supported when you use a time format string.

If your date and time values use formats different from each other, set this parameter to auto.

", "RedshiftSettings$Username": "

An Amazon Redshift user name for a registered user.

", + "RedshiftSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "RedshiftSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.

", "RefreshSchemasMessage$EndpointArn": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", "RefreshSchemasMessage$ReplicationInstanceArn": "

The Amazon Resource Name (ARN) of the replication instance.

", "RefreshSchemasStatus$EndpointArn": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", @@ -1872,8 +1888,8 @@ "S3Settings$BucketName": "

The name of the S3 bucket.

", "S3Settings$ServerSideEncryptionKmsKeyId": "

If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.

Here is a CLI example: aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value

", "S3Settings$TimestampColumnName": "

A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.

AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data when you set TimestampColumnName to a nonblank value.

For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.

For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.

The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.

When the AddColumnName parameter is set to true, DMS also includes a name for the timestamp column that you set with TimestampColumnName.

", - "S3Settings$CsvNoSupValue": "

This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.

This setting is supported in AWS DMS versions 3.4.1 and later.

", - "S3Settings$CdcPath": "

Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If CdcPath is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target, if CdcPathis set, it is the folder path where data changes are replicated. If you set PreserveTransactions to true, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by BucketFolder and BucketName .

For example, if you specify CdcPath as MyChangedData, and you specify BucketName as MyTargetBucket but do not specify BucketFolder, AWS DMS creates the CDC folder path following: MyTargetBucket/MyChangedData.

If you specify the same CdcPath, and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData, AWS DMS creates the CDC folder path following: MyTargetBucket/MyTargetData/MyChangedData.

This setting is supported in AWS DMS versions 3.4.2 and later.

", + "S3Settings$CsvNoSupValue": "

This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If UseCsvNoSupValue is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue setting.

This setting is supported in AWS DMS versions 3.4.1 and later.

", + "S3Settings$CdcPath": "

Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If CdcPath is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set PreserveTransactions to true, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by BucketFolder and BucketName .

For example, if you specify CdcPath as MyChangedData, and you specify BucketName as MyTargetBucket but do not specify BucketFolder, AWS DMS creates the CDC folder path following: MyTargetBucket/MyChangedData.

If you specify the same CdcPath, and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData, AWS DMS creates the CDC folder path following: MyTargetBucket/MyTargetData/MyChangedData.

For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target.

This setting is supported in AWS DMS versions 3.4.2 and later.

", "SchemaList$member": null, "SourceIdsList$member": null, "StartReplicationTaskAssessmentMessage$ReplicationTaskArn": "

The Amazon Resource Name (ARN) of the replication task.

", @@ -1897,6 +1913,8 @@ "SybaseSettings$DatabaseName": "

Database name for the endpoint.

", "SybaseSettings$ServerName": "

Fully qualified domain name of the endpoint.

", "SybaseSettings$Username": "

Endpoint connection user name.

", + "SybaseSettings$SecretsManagerAccessRoleArn": "

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

", + "SybaseSettings$SecretsManagerSecretId": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

", "TableStatistics$SchemaName": "

The schema name.

", "TableStatistics$TableName": "

The name of the table.

", "TableStatistics$TableState": "

The state of the tables described.

Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded

", diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 3278a81e035..2cfa71dbfb3 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -4215,6 +4215,10 @@ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "locationName":"TagSpecification" } } }, diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index c3c4d6f4f5f..ebf0c5da409 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -12176,7 +12176,7 @@ "LaunchTemplateTagSpecificationRequest$ResourceType": "

The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags.

", "SpotFleetTagSpecification$ResourceType": "

The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .

", "TagDescription$ResourceType": "

The resource type.

", - "TagSpecification$ResourceType": "

The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

To tag a resource after it has been created, see CreateTags.

" + "TagSpecification$ResourceType": "

The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image| import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group | prefix-list | natgateway | network-acl | network-interface | reserved-instances |route-table | security-group| snapshot | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.

To tag a resource after it has been created, see CreateTags.

" } }, "ResponseError": { @@ -14970,6 +14970,7 @@ "TagSpecificationList": { "base": null, "refs": { + "AllocateAddressRequest$TagSpecifications": "

The tags to assign to the Elastic IP address.

", "AllocateHostsRequest$TagSpecifications": "

The tags to apply to the Dedicated Host during creation.

", "CopySnapshotRequest$TagSpecifications": "

The tags to apply to the new snapshot.

", "CreateCapacityReservationRequest$TagSpecifications": "

The tags to apply to the Capacity Reservation during launch.

", diff --git a/models/apis/glue/2017-03-31/api-2.json b/models/apis/glue/2017-03-31/api-2.json index 64cbfbc0940..c4e71dd82a2 100644 --- a/models/apis/glue/2017-03-31/api-2.json +++ b/models/apis/glue/2017-03-31/api-2.json @@ -3250,7 +3250,11 @@ "KAFKA_BOOTSTRAP_SERVERS", "KAFKA_SSL_ENABLED", "KAFKA_CUSTOM_CERT", - "KAFKA_SKIP_CUSTOM_CERT_VALIDATION" + "KAFKA_SKIP_CUSTOM_CERT_VALIDATION", + "SECRET_ID", + "CONNECTOR_URL", + "CONNECTOR_TYPE", + "CONNECTOR_CLASS_NAME" ] }, "ConnectionType":{ @@ -3260,7 +3264,9 @@ "SFTP", "MONGODB", "KAFKA", - "NETWORK" + "NETWORK", + "MARKETPLACE", + "CUSTOM" ] }, "ConnectionsList":{ diff --git a/models/apis/glue/2017-03-31/docs-2.json b/models/apis/glue/2017-03-31/docs-2.json index f1d985cb398..0b507acd59b 100644 --- a/models/apis/glue/2017-03-31/docs-2.json +++ b/models/apis/glue/2017-03-31/docs-2.json @@ -899,7 +899,7 @@ "ConnectionProperties": { "base": null, "refs": { - "Connection$ConnectionProperties": "

These key-value pairs define parameters for the connection:

", + "Connection$ConnectionProperties": "

These key-value pairs define parameters for the connection:

", "ConnectionInput$ConnectionProperties": "

These key-value pairs define parameters for the connection.

" } }, @@ -913,7 +913,7 @@ "base": null, "refs": { "Connection$ConnectionType": "

The type of the connection. Currently, SFTP is not supported.

", - "ConnectionInput$ConnectionType": "

The type of the connection. Currently, these types are supported:

SFTP is not supported.

", + "ConnectionInput$ConnectionType": "

The type of the connection. Currently, these types are supported:

SFTP is not supported.

", "GetConnectionsFilter$ConnectionType": "

The type of connections to return. Currently, SFTP is not supported.

" } }, @@ -2554,7 +2554,7 @@ "RegistryId$RegistryArn": "

Arn of the registry to be updated. One of RegistryArn or RegistryName has to be provided.

", "RegistryListItem$RegistryArn": "

The Amazon Resource Name (ARN) of the registry.

", "RemoveSchemaVersionMetadataResponse$SchemaArn": "

The Amazon Resource Name (ARN) of the schema.

", - "SchemaId$SchemaArn": null, + "SchemaId$SchemaArn": "

The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

", "SchemaListItem$SchemaArn": "

The Amazon Resource Name (ARN) for the schema.

", "SchemaVersionListItem$SchemaArn": "

The Amazon Resource Name (ARN) of the schema.

", "TagResourceRequest$ResourceArn": "

The ARN of the AWS Glue resource to which to add the tags. For more information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern.

", @@ -2944,7 +2944,7 @@ "refs": { "PutSchemaVersionMetadataResponse$LatestVersion": "

The latest version of the schema.

", "RemoveSchemaVersionMetadataResponse$LatestVersion": "

The latest version of the schema.

", - "SchemaVersionNumber$LatestVersion": null + "SchemaVersionNumber$LatestVersion": "

The latest version available for the schema.

" } }, "LineageConfiguration": { @@ -4296,7 +4296,7 @@ } }, "SchemaId": { - "base": null, + "base": "

The unique ID of the schema in the AWS Glue schema registry.

", "refs": { "DeleteSchemaInput$SchemaId": "

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

", "DeleteSchemaVersionsInput$SchemaId": "

This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

", @@ -4357,8 +4357,8 @@ "RegistryListItem$RegistryName": "

The name of the registry.

", "RemoveSchemaVersionMetadataResponse$SchemaName": "

The name of the schema.

", "RemoveSchemaVersionMetadataResponse$RegistryName": "

The name of the registry.

", - "SchemaId$SchemaName": null, - "SchemaId$RegistryName": null, + "SchemaId$SchemaName": "

The name of the schema. One of SchemaArn or SchemaName has to be provided.

", + "SchemaId$RegistryName": "

The name of the schema registry that contains the schema.

", "SchemaListItem$RegistryName": "

the name of the registry where the schema resides.

", "SchemaListItem$SchemaName": "

The name of the schema.

", "UpdateRegistryResponse$RegistryName": "

The name of the updated registry.

", @@ -4437,7 +4437,7 @@ } }, "SchemaVersionNumber": { - "base": null, + "base": "

A structure containing the schema version information.

", "refs": { "GetSchemaVersionInput$SchemaVersionNumber": "

The version number of the schema.

", "GetSchemaVersionsDiffInput$FirstSchemaVersionNumber": "

The first of the two schema versions to be compared.

", @@ -5461,7 +5461,7 @@ "SchemaReference$SchemaVersionNumber": "

The version number of the schema.

", "SchemaVersionErrorItem$VersionNumber": "

The version number of the schema.

", "SchemaVersionListItem$VersionNumber": "

The version number of the schema.

", - "SchemaVersionNumber$VersionNumber": null + "SchemaVersionNumber$VersionNumber": "

The version number of the schema.

" } }, "VersionMismatchException": { diff --git a/models/apis/managedblockchain/2018-09-24/api-2.json b/models/apis/managedblockchain/2018-09-24/api-2.json index 535df0b87d3..a5a7251bee3 100644 --- a/models/apis/managedblockchain/2018-09-24/api-2.json +++ b/models/apis/managedblockchain/2018-09-24/api-2.json @@ -53,7 +53,7 @@ "name":"CreateNode", "http":{ "method":"POST", - "requestUri":"/networks/{networkId}/members/{memberId}/nodes" + "requestUri":"/networks/{networkId}/nodes" }, "input":{"shape":"CreateNodeInput"}, "output":{"shape":"CreateNodeOutput"}, @@ -106,7 +106,7 @@ "name":"DeleteNode", "http":{ "method":"DELETE", - "requestUri":"/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + "requestUri":"/networks/{networkId}/nodes/{nodeId}" }, "input":{"shape":"DeleteNodeInput"}, "output":{"shape":"DeleteNodeOutput"}, @@ -155,7 +155,7 @@ "name":"GetNode", "http":{ "method":"GET", - "requestUri":"/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + "requestUri":"/networks/{networkId}/nodes/{nodeId}" }, "input":{"shape":"GetNodeInput"}, "output":{"shape":"GetNodeOutput"}, @@ -234,7 +234,7 @@ "name":"ListNodes", "http":{ "method":"GET", - "requestUri":"/networks/{networkId}/members/{memberId}/nodes" + "requestUri":"/networks/{networkId}/nodes" }, "input":{"shape":"ListNodesInput"}, "output":{"shape":"ListNodesOutput"}, @@ -313,7 +313,7 @@ "name":"UpdateNode", "http":{ "method":"PATCH", - "requestUri":"/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + "requestUri":"/networks/{networkId}/nodes/{nodeId}" }, "input":{"shape":"UpdateNodeInput"}, "output":{"shape":"UpdateNodeOutput"}, @@ -347,6 +347,7 @@ "AccessDeniedException":{ "type":"structure", "members":{ + "Message":{"shape":"String"} }, "error":{"httpStatusCode":403}, "exception":true @@ -429,7 +430,6 @@ "required":[ "ClientRequestToken", "NetworkId", - "MemberId", "NodeConfiguration" ], "members":{ @@ -442,11 +442,7 @@ "location":"uri", "locationName":"networkId" }, - "MemberId":{ - "shape":"ResourceIdString", - "location":"uri", - "locationName":"memberId" - }, + "MemberId":{"shape":"ResourceIdString"}, "NodeConfiguration":{"shape":"NodeConfiguration"} } }, @@ -513,7 +509,6 @@ "type":"structure", "required":[ "NetworkId", - "MemberId", "NodeId" ], "members":{ @@ -524,7 +519,7 @@ }, "MemberId":{ "shape":"ResourceIdString", - "location":"uri", + "location":"querystring", "locationName":"memberId" }, "NodeId":{ @@ -556,7 +551,10 @@ }, "Framework":{ "type":"string", - "enum":["HYPERLEDGER_FABRIC"] + "enum":[ + "HYPERLEDGER_FABRIC", + "ETHEREUM" + ] }, "FrameworkVersionString":{ "type":"string", @@ -609,7 +607,6 @@ "type":"structure", "required":[ "NetworkId", - "MemberId", "NodeId" ], "members":{ @@ -620,7 +617,7 @@ }, "MemberId":{ "shape":"ResourceIdString", - "location":"uri", + "location":"querystring", "locationName":"memberId" }, "NodeId":{ @@ -828,10 +825,7 @@ }, "ListNodesInput":{ "type":"structure", - "required":[ - "NetworkId", - "MemberId" - ], + "required":["NetworkId"], "members":{ "NetworkId":{ "shape":"ResourceIdString", @@ -840,7 +834,7 @@ }, "MemberId":{ "shape":"ResourceIdString", - "location":"uri", + "location":"querystring", "locationName":"memberId" }, "Status":{ @@ -1064,6 +1058,12 @@ "CreationDate":{"shape":"Timestamp"} } }, + "NetworkEthereumAttributes":{ + "type":"structure", + "members":{ + "ChainId":{"shape":"String"} + } + }, "NetworkFabricAttributes":{ "type":"structure", "members":{ @@ -1081,7 +1081,8 @@ "NetworkFrameworkAttributes":{ "type":"structure", "members":{ - "Fabric":{"shape":"NetworkFabricAttributes"} + "Fabric":{"shape":"NetworkFabricAttributes"}, + "Ethereum":{"shape":"NetworkEthereumAttributes"} } }, "NetworkFrameworkConfiguration":{ @@ -1100,7 +1101,7 @@ "type":"string", "max":64, "min":1, - "pattern":"^(?!-)^[^0-9](?!.*--)[A-Za-z0-9-]+[^- ]$" + "pattern":"^(?!-|[0-9])(?!.*-$)(?!.*?--)[a-zA-Z0-9-]+$" }, "NetworkStatus":{ "type":"string", @@ -1145,10 +1146,7 @@ }, "NodeConfiguration":{ "type":"structure", - "required":[ - "InstanceType", - "AvailabilityZone" - ], + "required":["InstanceType"], "members":{ "InstanceType":{"shape":"InstanceTypeString"}, "AvailabilityZone":{"shape":"AvailabilityZoneString"}, @@ -1156,6 +1154,13 @@ "StateDB":{"shape":"StateDBType"} } }, + "NodeEthereumAttributes":{ + "type":"structure", + "members":{ + "HttpEndpoint":{"shape":"String"}, + "WebSocketEndpoint":{"shape":"String"} + } + }, "NodeFabricAttributes":{ "type":"structure", "members":{ @@ -1173,7 +1178,8 @@ "NodeFrameworkAttributes":{ "type":"structure", "members":{ - "Fabric":{"shape":"NodeFabricAttributes"} + "Fabric":{"shape":"NodeFabricAttributes"}, + "Ethereum":{"shape":"NodeEthereumAttributes"} } }, "NodeListMaxResults":{ @@ -1193,6 +1199,7 @@ "enum":[ "CREATING", "AVAILABLE", + "UNHEALTHY", "CREATE_FAILED", "UPDATING", "DELETING", @@ -1417,7 +1424,6 @@ "type":"structure", "required":[ "NetworkId", - "MemberId", "NodeId" ], "members":{ @@ -1426,11 +1432,7 @@ "location":"uri", "locationName":"networkId" }, - "MemberId":{ - "shape":"ResourceIdString", - "location":"uri", - "locationName":"memberId" - }, + "MemberId":{"shape":"ResourceIdString"}, "NodeId":{ "shape":"ResourceIdString", "location":"uri", diff --git a/models/apis/managedblockchain/2018-09-24/docs-2.json b/models/apis/managedblockchain/2018-09-24/docs-2.json index 545b9c62cc5..8b49996ebee 100644 --- a/models/apis/managedblockchain/2018-09-24/docs-2.json +++ b/models/apis/managedblockchain/2018-09-24/docs-2.json @@ -1,27 +1,27 @@ { "version": "2.0", - "service": "

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority. Currently, Managed Blockchain supports the Hyperledger Fabric open source framework.

", + "service": "

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.

Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember do not apply to Ethereum.

The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.

", "operations": { - "CreateMember": "

Creates a member within a Managed Blockchain network.

", - "CreateNetwork": "

Creates a new blockchain network using Amazon Managed Blockchain.

", - "CreateNode": "

Creates a peer node in a member.

", - "CreateProposal": "

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

", - "DeleteMember": "

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also.

", - "DeleteNode": "

Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.

", - "GetMember": "

Returns detailed information about a member.

", - "GetNetwork": "

Returns detailed information about a network.

", - "GetNode": "

Returns detailed information about a peer node.

", - "GetProposal": "

Returns detailed information about a proposal.

", - "ListInvitations": "

Returns a listing of all invitations for the current AWS account.

", - "ListMembers": "

Returns a listing of the members in a network and properties of their configurations.

", - "ListNetworks": "

Returns information about the networks in which the current AWS account has members.

", - "ListNodes": "

Returns information about the nodes within a network.

", - "ListProposalVotes": "

Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

", - "ListProposals": "

Returns a listing of proposals for the network.

", - "RejectInvitation": "

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

", - "UpdateMember": "

Updates a member configuration with new parameters.

", - "UpdateNode": "

Updates a node configuration with new parameters.

", - "VoteOnProposal": "

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action.

" + "CreateMember": "

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

", + "CreateNetwork": "

Creates a new blockchain network using Amazon Managed Blockchain.

Applies only to Hyperledger Fabric.

", + "CreateNode": "

Creates a node on the specified blockchain network.

Applies to Hyperledger Fabric and Ethereum.

", + "CreateProposal": "

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

Applies only to Hyperledger Fabric.

", + "DeleteMember": "

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also.

Applies only to Hyperledger Fabric.

", + "DeleteNode": "

Deletes a node that your AWS account owns. All data on the node is lost and cannot be recovered.

Applies to Hyperledger Fabric and Ethereum.

", + "GetMember": "

Returns detailed information about a member.

Applies only to Hyperledger Fabric.

", + "GetNetwork": "

Returns detailed information about a network.

Applies to Hyperledger Fabric and Ethereum.

", + "GetNode": "

Returns detailed information about a node.

Applies to Hyperledger Fabric and Ethereum.

", + "GetProposal": "

Returns detailed information about a proposal.

Applies only to Hyperledger Fabric.

", + "ListInvitations": "

Returns a list of all invitations for the current AWS account.

Applies only to Hyperledger Fabric.

", + "ListMembers": "

Returns a list of the members in a network and properties of their configurations.

Applies only to Hyperledger Fabric.

", + "ListNetworks": "

Returns information about the networks in which the current AWS account participates.

Applies to Hyperledger Fabric and Ethereum.

", + "ListNodes": "

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

", + "ListProposalVotes": "

Returns the list of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

Applies only to Hyperledger Fabric.

", + "ListProposals": "

Returns a list of proposals for the network.

Applies only to Hyperledger Fabric.

", + "RejectInvitation": "

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

Applies only to Hyperledger Fabric.

", + "UpdateMember": "

Updates a member configuration with new parameters.

Applies only to Hyperledger Fabric.

", + "UpdateNode": "

Updates a node configuration with new parameters.

Applies only to Hyperledger Fabric.

", + "VoteOnProposal": "

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action.

Applies only to Hyperledger Fabric.

" }, "shapes": { "AccessDeniedException": { @@ -30,7 +30,7 @@ } }, "ApprovalThresholdPolicy": { - "base": "

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

", + "base": "

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

Applies only to Hyperledger Fabric.

", "refs": { "VotingPolicy$ApprovalThresholdPolicy": "

Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

" } @@ -220,7 +220,7 @@ } }, "Invitation": { - "base": "

An invitation to an AWS account to create a member and join the network.

", + "base": "

An invitation to an AWS account to create a member and join the network.

Applies only to Hyperledger Fabric.

", "refs": { "InvitationList$member": null } @@ -238,7 +238,7 @@ } }, "InviteAction": { - "base": "

An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED.

", + "base": "

An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED.

Applies only to Hyperledger Fabric.

", "refs": { "InviteActionList$member": null } @@ -331,13 +331,13 @@ } }, "Member": { - "base": "

Member configuration properties.

", + "base": "

Member configuration properties.

Applies only to Hyperledger Fabric.

", "refs": { "GetMemberOutput$Member": "

The properties of a member.

" } }, "MemberConfiguration": { - "base": "

Configuration properties of the member.

", + "base": "

Configuration properties of the member.

Applies only to Hyperledger Fabric.

", "refs": { "CreateMemberInput$MemberConfiguration": "

Member configuration parameters.

", "CreateNetworkInput$MemberConfiguration": "

Configuration properties for the first member within the network.

" @@ -396,7 +396,7 @@ } }, "MemberSummary": { - "base": "

A summary of configuration properties for a member.

", + "base": "

A summary of configuration properties for a member.

Applies only to Hyperledger Fabric.

", "refs": { "MemberSummaryList$member": null } @@ -421,6 +421,12 @@ "GetNetworkOutput$Network": "

An object containing network configuration parameters.

" } }, + "NetworkEthereumAttributes": { + "base": "

Attributes of Ethereum for a network.

", + "refs": { + "NetworkFrameworkAttributes$Ethereum": "

Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network.

" + } + }, "NetworkFabricAttributes": { "base": "

Attributes of Hyperledger Fabric for a network.

", "refs": { @@ -465,7 +471,7 @@ "NetworkStatus": { "base": null, "refs": { - "ListNetworksInput$Status": "

An optional status specifier. If provided, only networks currently in this status are listed.

", + "ListNetworksInput$Status": "

An optional status specifier. If provided, only networks currently in this status are listed.

Applies only to Hyperledger Fabric.

", "Network$Status": "

The current status of the network.

", "NetworkSummary$Status": "

The current status of the network.

" } @@ -484,19 +490,25 @@ } }, "Node": { - "base": "

Configuration properties of a peer node.

", + "base": "

Configuration properties of a node.

", "refs": { "GetNodeOutput$Node": "

Properties of the node configuration.

" } }, "NodeConfiguration": { - "base": "

Configuration properties of a peer node.

", + "base": "

Configuration properties of a node.

", "refs": { "CreateNodeInput$NodeConfiguration": "

The properties of a node configuration.

" } }, + "NodeEthereumAttributes": { + "base": "

Attributes of an Ethereum node.

", + "refs": { + "NodeFrameworkAttributes$Ethereum": "

Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum.

" + } + }, "NodeFabricAttributes": { - "base": "

Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

", + "base": "

Attributes of Hyperledger Fabric for a peer node on a Hyperledger Fabric network on Managed Blockchain.

", "refs": { "NodeFrameworkAttributes$Fabric": "

Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

" } @@ -508,7 +520,7 @@ } }, "NodeFrameworkAttributes": { - "base": "

Attributes relevant to a peer node on a Managed Blockchain network for the blockchain framework that the network uses.

", + "base": "

Attributes relevant to a node on a Managed Blockchain network for the blockchain framework that the network uses.

", "refs": { "Node$FrameworkAttributes": "

Attributes of the blockchain framework being used.

" } @@ -520,10 +532,10 @@ } }, "NodeLogPublishingConfiguration": { - "base": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

", + "base": "

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

", "refs": { - "Node$LogPublishingConfiguration": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

", - "NodeConfiguration$LogPublishingConfiguration": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

", + "Node$LogPublishingConfiguration": "

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

", + "NodeConfiguration$LogPublishingConfiguration": "

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

", "UpdateNodeInput$LogPublishingConfiguration": "

Configuration properties for publishing to Amazon CloudWatch Logs.

" } }, @@ -536,7 +548,7 @@ } }, "NodeSummary": { - "base": "

A summary of configuration properties for a peer node.

", + "base": "

A summary of configuration properties for a node.

", "refs": { "NodeSummaryList$member": null } @@ -567,7 +579,7 @@ "PasswordString": { "base": null, "refs": { - "MemberFabricConfiguration$AdminPassword": "

The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(\\), @, or a space.

" + "MemberFabricConfiguration$AdminPassword": "

The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(\\), @, or a space.

" } }, "PrincipalString": { @@ -577,13 +589,13 @@ } }, "Proposal": { - "base": "

Properties of a proposal on a Managed Blockchain network.

", + "base": "

Properties of a proposal on a Managed Blockchain network.

Applies only to Hyperledger Fabric.

", "refs": { "GetProposalOutput$Proposal": "

Information about a proposal.

" } }, "ProposalActions": { - "base": "

The actions to carry out if a proposal is APPROVED.

", + "base": "

The actions to carry out if a proposal is APPROVED.

Applies only to Hyperledger Fabric.

", "refs": { "CreateProposalInput$Actions": "

The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.

", "Proposal$Actions": "

The actions to perform on the network if the proposal is APPROVED.

" @@ -611,7 +623,7 @@ } }, "ProposalSummary": { - "base": "

Properties of a proposal.

", + "base": "

Properties of a proposal.

Applies only to Hyperledger Fabric.

", "refs": { "ProposalSummaryList$member": null } @@ -625,7 +637,7 @@ "ProposalVoteList": { "base": null, "refs": { - "ListProposalVotesOutput$ProposalVotes": "

The listing of votes.

" + "ListProposalVotesOutput$ProposalVotes": "

The list of votes.

" } }, "RejectInvitationInput": { @@ -639,7 +651,7 @@ } }, "RemoveAction": { - "base": "

An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED. The member and all associated resources are deleted from the network.

", + "base": "

An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED. The member and all associated resources are deleted from the network.

Applies only to Hyperledger Fabric.

", "refs": { "RemoveActionList$member": null } @@ -663,29 +675,29 @@ "CreateMemberOutput$MemberId": "

The unique identifier of the member.

", "CreateNetworkOutput$NetworkId": "

The unique identifier for the network.

", "CreateNetworkOutput$MemberId": "

The unique identifier for the first member within the network.

", - "CreateNodeInput$NetworkId": "

The unique identifier of the network in which this node runs.

", - "CreateNodeInput$MemberId": "

The unique identifier of the member that owns this node.

", + "CreateNodeInput$NetworkId": "

The unique identifier of the network for the node.

Ethereum public networks have the following NetworkIds:

", + "CreateNodeInput$MemberId": "

The unique identifier of the member that owns this node.

Applies only to Hyperledger Fabric.

", "CreateNodeOutput$NodeId": "

The unique identifier of the node.

", "CreateProposalInput$NetworkId": "

The unique identifier of the network for which the proposal is made.

", "CreateProposalInput$MemberId": "

The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single AWS account.

", "CreateProposalOutput$ProposalId": "

The unique identifier of the proposal.

", "DeleteMemberInput$NetworkId": "

The unique identifier of the network from which the member is removed.

", "DeleteMemberInput$MemberId": "

The unique identifier of the member to remove.

", - "DeleteNodeInput$NetworkId": "

The unique identifier of the network that the node belongs to.

", - "DeleteNodeInput$MemberId": "

The unique identifier of the member that owns this node.

", + "DeleteNodeInput$NetworkId": "

The unique identifier of the network that the node is on.

Ethereum public networks have the following NetworkIds:

", + "DeleteNodeInput$MemberId": "

The unique identifier of the member that owns this node.

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

", "DeleteNodeInput$NodeId": "

The unique identifier of the node.

", "GetMemberInput$NetworkId": "

The unique identifier of the network to which the member belongs.

", "GetMemberInput$MemberId": "

The unique identifier of the member.

", "GetNetworkInput$NetworkId": "

The unique identifier of the network to get information about.

", - "GetNodeInput$NetworkId": "

The unique identifier of the network to which the node belongs.

", - "GetNodeInput$MemberId": "

The unique identifier of the member that owns the node.

", + "GetNodeInput$NetworkId": "

The unique identifier of the network that the node is on.

", + "GetNodeInput$MemberId": "

The unique identifier of the member that owns the node.

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

", "GetNodeInput$NodeId": "

The unique identifier of the node.

", "GetProposalInput$NetworkId": "

The unique identifier of the network for which the proposal is made.

", "GetProposalInput$ProposalId": "

The unique identifier of the proposal.

", "Invitation$InvitationId": "

The unique identifier for the invitation.

", "ListMembersInput$NetworkId": "

The unique identifier of the network for which to list members.

", "ListNodesInput$NetworkId": "

The unique identifier of the network for which to list nodes.

", - "ListNodesInput$MemberId": "

The unique identifier of the member who owns the nodes to list.

", + "ListNodesInput$MemberId": "

The unique identifier of the member who owns the nodes to list.

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

", "ListProposalVotesInput$NetworkId": "

The unique identifier of the network.

", "ListProposalVotesInput$ProposalId": "

The unique identifier of the proposal.

", "ListProposalsInput$NetworkId": "

The unique identifier of the network.

", @@ -694,8 +706,8 @@ "MemberSummary$Id": "

The unique identifier of the member.

", "Network$Id": "

The unique identifier of the network.

", "NetworkSummary$Id": "

The unique identifier of the network.

", - "Node$NetworkId": "

The unique identifier of the network that the node is in.

", - "Node$MemberId": "

The unique identifier of the member to which the node belongs.

", + "Node$NetworkId": "

The unique identifier of the network that the node is on.

", + "Node$MemberId": "

The unique identifier of the member to which the node belongs.

Applies only to Hyperledger Fabric.

", "Node$Id": "

The unique identifier of the node.

", "NodeSummary$Id": "

The unique identifier of the node.

", "Proposal$ProposalId": "

The unique identifier of the proposal.

", @@ -705,11 +717,11 @@ "ProposalSummary$ProposedByMemberId": "

The unique identifier of the member that created the proposal.

", "RejectInvitationInput$InvitationId": "

The unique identifier of the invitation to reject.

", "RemoveAction$MemberId": "

The unique identifier of the member to remove.

", - "UpdateMemberInput$NetworkId": "

The unique ID of the Managed Blockchain network to which the member belongs.

", - "UpdateMemberInput$MemberId": "

The unique ID of the member.

", - "UpdateNodeInput$NetworkId": "

The unique ID of the Managed Blockchain network to which the node belongs.

", - "UpdateNodeInput$MemberId": "

The unique ID of the member that owns the node.

", - "UpdateNodeInput$NodeId": "

The unique ID of the node.

", + "UpdateMemberInput$NetworkId": "

The unique identifier of the Managed Blockchain network to which the member belongs.

", + "UpdateMemberInput$MemberId": "

The unique identifier of the member.

", + "UpdateNodeInput$NetworkId": "

The unique identifier of the network that the node is on.

", + "UpdateNodeInput$MemberId": "

The unique identifier of the member that owns the node.

Applies only to Hyperledger Fabric.

", + "UpdateNodeInput$NodeId": "

The unique identifier of the node.

", "VoteOnProposalInput$NetworkId": "

The unique identifier of the network.

", "VoteOnProposalInput$ProposalId": "

The unique identifier of the proposal.

", "VoteOnProposalInput$VoterMemberId": "

The unique identifier of the member casting the vote.

", @@ -734,20 +746,24 @@ "StateDBType": { "base": null, "refs": { - "Node$StateDB": "

The state database that the node uses. Values are LevelDB or CouchDB.

", - "NodeConfiguration$StateDB": "

The state database that the node uses. Values are LevelDB or CouchDB. When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is CouchDB.

" + "Node$StateDB": "

The state database that the node uses. Values are LevelDB or CouchDB.

Applies only to Hyperledger Fabric.

", + "NodeConfiguration$StateDB": "

The state database that the node uses. Values are LevelDB or CouchDB. When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is CouchDB.

Applies only to Hyperledger Fabric.

" } }, "String": { "base": null, "refs": { + "AccessDeniedException$Message": null, "IllegalActionException$Message": null, "InvalidRequestException$Message": null, "ListMembersInput$Name": "

The optional name of the member to list.

", "ListNetworksInput$Name": "

The name of the network.

", "MemberFabricAttributes$CaEndpoint": "

The endpoint used to access the member's certificate authority.

", "Network$VpcEndpointServiceName": "

The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources.

", + "NetworkEthereumAttributes$ChainId": "

The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:

", "NetworkFabricAttributes$OrderingServiceEndpoint": "

The endpoint of the ordering service for the network.

", + "NodeEthereumAttributes$HttpEndpoint": "

The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over HTTP connections from a client. Use this endpoint in client code for smart contracts when using an HTTP connection. Connections to this endpoint are authenticated using Signature Version 4.

", + "NodeEthereumAttributes$WebSocketEndpoint": "

The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over WebSockets connections from a client. Use this endpoint in client code for smart contracts when using a WebSockets connection. Connections to this endpoint are authenticated using Signature Version 4.

", "NodeFabricAttributes$PeerEndpoint": "

The endpoint that identifies the peer node for all services except peer channel-based event services.

", "NodeFabricAttributes$PeerEventEndpoint": "

The endpoint that identifies the peer node for peer channel-based event services.

", "ResourceAlreadyExistsException$Message": null, @@ -836,7 +852,7 @@ } }, "VoteSummary": { - "base": "

Properties of an individual vote that a member cast for a proposal.

", + "base": "

Properties of an individual vote that a member cast for a proposal.

Applies only to Hyperledger Fabric.

", "refs": { "ProposalVoteList$member": null } @@ -849,7 +865,7 @@ } }, "VotingPolicy": { - "base": "

The voting rules for the network to decide if a proposal is accepted

", + "base": "

The voting rules for the network to decide if a proposal is accepted

Applies only to Hyperledger Fabric.

", "refs": { "CreateNetworkInput$VotingPolicy": "

The voting rules used by the network to determine if a proposal is approved.

", "Network$VotingPolicy": "

The voting rules for the network to decide if a proposal is accepted.

" diff --git a/models/apis/outposts/2019-12-03/api-2.json b/models/apis/outposts/2019-12-03/api-2.json index 1a9575d96c2..f6d4952e246 100644 --- a/models/apis/outposts/2019-12-03/api-2.json +++ b/models/apis/outposts/2019-12-03/api-2.json @@ -116,6 +116,48 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"NotFoundException"} + ] } }, "shapes":{ @@ -132,6 +174,11 @@ "max":12, "min":12 }, + "Arn":{ + "type":"string", + "max":1011, + "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:([a-z\\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$" + }, "AvailabilityZone":{ "type":"string", "max":1000, @@ -314,6 +361,23 @@ "NextToken":{"shape":"Token"} } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagMap"} + } + }, "MaxResults1000":{ "type":"integer", "box":true, @@ -415,6 +479,12 @@ "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, @@ -422,6 +492,26 @@ "max":50, "min":1 }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{"shape":"TagMap"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "TagValue":{ "type":"string", "max":256, @@ -433,6 +523,30 @@ "min":1, "pattern":".*\\S.*" }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/models/apis/outposts/2019-12-03/docs-2.json b/models/apis/outposts/2019-12-03/docs-2.json index 1623b07bc4e..804b6873208 100644 --- a/models/apis/outposts/2019-12-03/docs-2.json +++ b/models/apis/outposts/2019-12-03/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

AWS Outposts is a fully-managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS-managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.

", + "service": "

AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.

", "operations": { "CreateOutpost": "

Creates an Outpost.

", "DeleteOutpost": "

Deletes the Outpost.

", @@ -8,7 +8,10 @@ "GetOutpost": "

Gets information about the specified Outpost.

", "GetOutpostInstanceTypes": "

Lists the instance types for the specified Outpost.

", "ListOutposts": "

List the Outposts for your AWS account.

", - "ListSites": "

Lists the sites for the specified AWS account.

" + "ListSites": "

Lists the sites for the specified AWS account.

", + "ListTagsForResource": "

Lists the tags for the specified resource.

", + "TagResource": "

Adds tags to the specified resource.

", + "UntagResource": "

Removes tags from the specified resource.

" }, "shapes": { "AccessDeniedException": { @@ -22,6 +25,14 @@ "Site$AccountId": null } }, + "Arn": { + "base": null, + "refs": { + "ListTagsForResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", + "TagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

", + "UntagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, "AvailabilityZone": { "base": "

The Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId.

", "refs": { @@ -145,6 +156,16 @@ "refs": { } }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, "MaxResults1000": { "base": "

The maximum page size.

", "refs": { @@ -174,7 +195,7 @@ } }, "OutpostDescription": { - "base": "

The Outpost description.

", + "base": "

The description of the Outpost.

", "refs": { "CreateOutpostInput$Description": null, "Outpost$Description": null @@ -238,15 +259,34 @@ "TagKey": { "base": null, "refs": { + "TagKeyList$member": null, "TagMap$key": null } }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$TagKeys": "

The tag keys.

" + } + }, "TagMap": { "base": null, "refs": { "CreateOutpostInput$Tags": "

The tags to apply to the Outpost.

", + "ListTagsForResourceResponse$Tags": "

The resource tags.

", "Outpost$Tags": "

The Outpost tags.

", - "Site$Tags": "

The site tags.

" + "Site$Tags": "

The site tags.

", + "TagResourceRequest$Tags": "

The tags to add to the resource.

" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { } }, "TagValue": { @@ -266,6 +306,16 @@ "ListSitesOutput$NextToken": null } }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, "ValidationException": { "base": "

A parameter is not valid.

", "refs": { diff --git a/models/apis/qldb-session/2019-07-11/api-2.json b/models/apis/qldb-session/2019-07-11/api-2.json index 32dc33dafa1..2c87d83c32c 100644 --- a/models/apis/qldb-session/2019-07-11/api-2.json +++ b/models/apis/qldb-session/2019-07-11/api-2.json @@ -40,6 +40,7 @@ "AbortTransactionResult":{ "type":"structure", "members":{ + "TimingInformation":{"shape":"TimingInformation"} } }, "BadRequestException":{ @@ -66,7 +67,9 @@ "type":"structure", "members":{ "TransactionId":{"shape":"TransactionId"}, - "CommitDigest":{"shape":"CommitDigest"} + "CommitDigest":{"shape":"CommitDigest"}, + "TimingInformation":{"shape":"TimingInformation"}, + "ConsumedIOs":{"shape":"IOUsage"} } }, "EndSessionRequest":{ @@ -77,6 +80,7 @@ "EndSessionResult":{ "type":"structure", "members":{ + "TimingInformation":{"shape":"TimingInformation"} } }, "ErrorCode":{"type":"string"}, @@ -96,7 +100,9 @@ "ExecuteStatementResult":{ "type":"structure", "members":{ - "FirstPage":{"shape":"Page"} + "FirstPage":{"shape":"Page"}, + "TimingInformation":{"shape":"TimingInformation"}, + "ConsumedIOs":{"shape":"IOUsage"} } }, "FetchPageRequest":{ @@ -113,7 +119,16 @@ "FetchPageResult":{ "type":"structure", "members":{ - "Page":{"shape":"Page"} + "Page":{"shape":"Page"}, + "TimingInformation":{"shape":"TimingInformation"}, + "ConsumedIOs":{"shape":"IOUsage"} + } + }, + "IOUsage":{ + "type":"structure", + "members":{ + "ReadIOs":{"shape":"ReadIOs"}, + "WriteIOs":{"shape":"WriteIOs"} } }, "InvalidSessionException":{ @@ -167,6 +182,7 @@ "min":4, "pattern":"^[A-Za-z-0-9+/=]+$" }, + "ProcessingTimeMilliseconds":{"type":"long"}, "RateExceededException":{ "type":"structure", "members":{ @@ -174,6 +190,7 @@ }, "exception":true }, + "ReadIOs":{"type":"long"}, "SendCommandRequest":{ "type":"structure", "members":{ @@ -215,7 +232,8 @@ "StartSessionResult":{ "type":"structure", "members":{ - "SessionToken":{"shape":"SessionToken"} + "SessionToken":{"shape":"SessionToken"}, + "TimingInformation":{"shape":"TimingInformation"} } }, "StartTransactionRequest":{ @@ -226,7 +244,8 @@ "StartTransactionResult":{ "type":"structure", "members":{ - "TransactionId":{"shape":"TransactionId"} + "TransactionId":{"shape":"TransactionId"}, + "TimingInformation":{"shape":"TimingInformation"} } }, "Statement":{ @@ -238,6 +257,12 @@ "type":"list", "member":{"shape":"ValueHolder"} }, + "TimingInformation":{ + "type":"structure", + "members":{ + "ProcessingTimeMilliseconds":{"shape":"ProcessingTimeMilliseconds"} + } + }, "TransactionId":{ "type":"string", "max":22, @@ -254,6 +279,7 @@ "ValueHolders":{ "type":"list", "member":{"shape":"ValueHolder"} - } + }, + "WriteIOs":{"type":"long"} } } diff --git a/models/apis/qldb-session/2019-07-11/docs-2.json b/models/apis/qldb-session/2019-07-11/docs-2.json index bc9e1360b63..6519b7a3b22 100644 --- a/models/apis/qldb-session/2019-07-11/docs-2.json +++ b/models/apis/qldb-session/2019-07-11/docs-2.json @@ -1,8 +1,8 @@ { "version": "2.0", - "service": "

The transactional data APIs for Amazon QLDB

Instead of interacting directly with this API, we recommend that you use the Amazon QLDB Driver or the QLDB Shell to execute data transactions on a ledger.

", + "service": "

The transactional data APIs for Amazon QLDB

Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.

", "operations": { - "SendCommand": "

Sends a command to an Amazon QLDB ledger.

Instead of interacting directly with this API, we recommend that you use the Amazon QLDB Driver or the QLDB Shell to execute data transactions on a ledger.

" + "SendCommand": "

Sends a command to an Amazon QLDB ledger.

Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.

" }, "shapes": { "AbortTransactionRequest": { @@ -25,7 +25,7 @@ "CommitDigest": { "base": null, "refs": { - "CommitTransactionRequest$CommitDigest": "

Specifies the commit digest for the transaction to commit. For every active transaction, the commit digest must be passed. QLDB validates CommitDigest and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.

", + "CommitTransactionRequest$CommitDigest": "

Specifies the commit digest for the transaction to commit. For every active transaction, the commit digest must be passed. QLDB validates CommitDigest and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.

The purpose of the CommitDigest parameter is to ensure that QLDB commits a transaction if and only if the server has processed the exact set of statements sent by the client, in the same order that client sent them, and with no duplicates.

", "CommitTransactionResult$CommitDigest": "

The commit digest of the committed transaction.

" } }, @@ -94,6 +94,14 @@ "SendCommandResult$FetchPage": "

Contains the details of the fetched page.

" } }, + "IOUsage": { + "base": "

Contains I/O usage metrics for a command that was invoked.

", + "refs": { + "CommitTransactionResult$ConsumedIOs": "

Contains metrics about the number of I/O requests that were consumed.

", + "ExecuteStatementResult$ConsumedIOs": "

Contains metrics about the number of I/O requests that were consumed.

", + "FetchPageResult$ConsumedIOs": "

Contains metrics about the number of I/O requests that were consumed.

" + } + }, "InvalidSessionException": { "base": "

Returned if the session doesn't exist anymore because it timed out or expired.

", "refs": { @@ -141,11 +149,23 @@ "Page$NextPageToken": "

The token of the next page.

" } }, + "ProcessingTimeMilliseconds": { + "base": null, + "refs": { + "TimingInformation$ProcessingTimeMilliseconds": "

The amount of time that was taken for the command to finish processing, measured in milliseconds.

" + } + }, "RateExceededException": { "base": "

Returned when the rate of requests exceeds the allowed throughput.

", "refs": { } }, + "ReadIOs": { + "base": null, + "refs": { + "IOUsage$ReadIOs": "

The number of read I/O requests that the command performed.

" + } + }, "SendCommandRequest": { "base": null, "refs": { @@ -199,6 +219,18 @@ "ExecuteStatementRequest$Parameters": "

Specifies the parameters for the parameterized statement in the request.

" } }, + "TimingInformation": { + "base": "

Contains server-side performance information for a command. Amazon QLDB captures timing information between the times when it receives the request and when it sends the corresponding response.

", + "refs": { + "AbortTransactionResult$TimingInformation": "

Contains server-side performance information for the command.

", + "CommitTransactionResult$TimingInformation": "

Contains server-side performance information for the command.

", + "EndSessionResult$TimingInformation": "

Contains server-side performance information for the command.

", + "ExecuteStatementResult$TimingInformation": "

Contains server-side performance information for the command.

", + "FetchPageResult$TimingInformation": "

Contains server-side performance information for the command.

", + "StartSessionResult$TimingInformation": "

Contains server-side performance information for the command.

", + "StartTransactionResult$TimingInformation": "

Contains server-side performance information for the command.

" + } + }, "TransactionId": { "base": null, "refs": { @@ -210,7 +242,7 @@ } }, "ValueHolder": { - "base": "

A structure that can contain an Amazon Ion value in multiple encoding formats.

", + "base": "

A structure that can contain a value in multiple encoding formats.

", "refs": { "StatementParameters$member": null, "ValueHolders$member": null @@ -221,6 +253,12 @@ "refs": { "Page$Values": "

A structure that contains values in multiple encoding formats.

" } + }, + "WriteIOs": { + "base": null, + "refs": { + "IOUsage$WriteIOs": "

The number of write I/O requests that the command performed.

" + } } } } diff --git a/models/apis/s3/2006-03-01/api-2.json b/models/apis/s3/2006-03-01/api-2.json index 57c25752f60..a1cfa8b45aa 100644 --- a/models/apis/s3/2006-03-01/api-2.json +++ b/models/apis/s3/2006-03-01/api-2.json @@ -6734,7 +6734,10 @@ "ResponseContentEncoding":{"type":"string"}, "ResponseContentLanguage":{"type":"string"}, "ResponseContentType":{"type":"string"}, - "ResponseExpires":{"type":"timestamp"}, + "ResponseExpires":{ + "type":"timestamp", + "timestampFormat":"rfc822" + }, "Restore":{"type":"string"}, "RestoreObjectOutput":{ "type":"structure", diff --git a/models/apis/s3/2006-03-01/examples-1.json b/models/apis/s3/2006-03-01/examples-1.json index e6528d7d271..661b5de3542 100644 --- a/models/apis/s3/2006-03-01/examples-1.json +++ b/models/apis/s3/2006-03-01/examples-1.json @@ -84,13 +84,10 @@ "CreateBucket": [ { "input": { - "Bucket": "examplebucket", - "CreateBucketConfiguration": { - "LocationConstraint": "eu-west-1" - } + "Bucket": "examplebucket" }, "output": { - "Location": "http://examplebucket..s3.amazonaws.com/" + "Location": "/examplebucket" }, "comments": { "input": { @@ -98,16 +95,19 @@ "output": { } }, - "description": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", - "id": "to-create-a-bucket-in-a-specific-region-1483399072992", - "title": "To create a bucket in a specific region" + "description": "The following example creates a bucket.", + "id": "to-create-a-bucket--1472851826060", + "title": "To create a bucket " }, { "input": { - "Bucket": "examplebucket" + "Bucket": "examplebucket", + "CreateBucketConfiguration": { + "LocationConstraint": "eu-west-1" + } }, "output": { - "Location": "/examplebucket" + "Location": "http://examplebucket..s3.amazonaws.com/" }, "comments": { "input": { @@ -115,9 +115,9 @@ "output": { } }, - "description": "The following example creates a bucket.", - "id": "to-create-a-bucket--1472851826060", - "title": "To create a bucket " + "description": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", + "id": "to-create-a-bucket-in-a-specific-region-1483399072992", + "title": "To create a bucket in a specific region" } ], "CreateMultipartUpload": [ @@ -292,10 +292,11 @@ { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "HappyFace.jpg", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "output": { - "VersionId": "null" + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "comments": { "input": { @@ -303,18 +304,17 @@ "output": { } }, - "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", - "id": "to-remove-tag-set-from-an-object-1483145342862", - "title": "To remove tag set from an object" + "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", + "id": "to-remove-tag-set-from-an-object-version-1483145285913", + "title": "To remove tag set from an object version" }, { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "Key": "HappyFace.jpg" }, "output": { - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "VersionId": "null" }, "comments": { "input": { @@ -322,9 +322,9 @@ "output": { } }, - "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", - "id": "to-remove-tag-set-from-an-object-version-1483145285913", - "title": "To remove tag set from an object version" + "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", + "id": "to-remove-tag-set-from-an-object-1483145342862", + "title": "To remove tag set from an object" } ], "DeleteObjects": [ @@ -334,10 +334,12 @@ "Delete": { "Objects": [ { - "Key": "objectkey1" + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" }, { - "Key": "objectkey2" + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" } ], "Quiet": false @@ -346,14 +348,12 @@ "output": { "Deleted": [ { - "DeleteMarker": "true", - "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", - "Key": "objectkey1" + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" }, { - "DeleteMarker": "true", - "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", - "Key": "objectkey2" + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" } ] }, @@ -363,9 +363,9 @@ "output": { } }, - "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", - "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", - "title": "To delete multiple objects from a versioned bucket" + "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", + "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", + "title": "To delete multiple object versions from a versioned bucket" }, { "input": { @@ -373,12 +373,10 @@ "Delete": { "Objects": [ { - "Key": "HappyFace.jpg", - "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + "Key": "objectkey1" }, { - "Key": "HappyFace.jpg", - "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + "Key": "objectkey2" } ], "Quiet": false @@ -387,12 +385,14 @@ "output": { "Deleted": [ { - "Key": "HappyFace.jpg", - "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + "DeleteMarker": "true", + "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", + "Key": "objectkey1" }, { - "Key": "HappyFace.jpg", - "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + "DeleteMarker": "true", + "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", + "Key": "objectkey2" } ] }, @@ -402,9 +402,9 @@ "output": { } }, - "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", - "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", - "title": "To delete multiple object versions from a versioned bucket" + "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", + "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", + "title": "To delete multiple objects from a versioned bucket" } ], "GetBucketCors": [ @@ -728,17 +728,18 @@ { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "SampleFile.txt", + "Range": "bytes=0-9" }, "output": { "AcceptRanges": "bytes", - "ContentLength": "3191", - "ContentType": "image/jpeg", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT", + "ContentLength": "10", + "ContentRange": "bytes 0-9/43", + "ContentType": "text/plain", + "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"", + "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT", "Metadata": { }, - "TagCount": 2, "VersionId": "null" }, "comments": { @@ -747,25 +748,24 @@ "output": { } }, - "description": "The following example retrieves an object for an S3 bucket.", - "id": "to-retrieve-an-object-1481827837012", - "title": "To retrieve an object" + "description": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.", + "id": "to-retrieve-a-byte-range-of-an-object--1481832674603", + "title": "To retrieve a byte range of an object " }, { "input": { "Bucket": "examplebucket", - "Key": "SampleFile.txt", - "Range": "bytes=0-9" + "Key": "HappyFace.jpg" }, "output": { "AcceptRanges": "bytes", - "ContentLength": "10", - "ContentRange": "bytes 0-9/43", - "ContentType": "text/plain", - "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"", - "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT", + "ContentLength": "3191", + "ContentType": "image/jpeg", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT", "Metadata": { }, + "TagCount": 2, "VersionId": "null" }, "comments": { @@ -774,9 +774,9 @@ "output": { } }, - "description": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.", - "id": "to-retrieve-a-byte-range-of-an-object--1481832674603", - "title": "To retrieve a byte range of an object " + "description": "The following example retrieves an object for an S3 bucket.", + "id": "to-retrieve-an-object-1481827837012", + "title": "To retrieve an object" } ], "GetObjectAcl": [ @@ -1567,13 +1567,16 @@ "PutObject": [ { "input": { - "Body": "HappyFace.jpg", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "exampleobject", + "ServerSideEncryption": "AES256", + "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" + "ServerSideEncryption": "AES256", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" }, "comments": { "input": { @@ -1581,20 +1584,19 @@ "output": { } }, - "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", - "id": "to-upload-an-object-1481760101010", - "title": "To upload an object" + "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", + "title": "To upload an object and specify server-side encryption and object tags" }, { "input": { - "ACL": "authenticated-read", "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "exampleobject" + "Key": "objectkey" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" }, "comments": { "input": { @@ -1602,22 +1604,20 @@ "output": { } }, - "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", - "title": "To upload an object and specify canned ACL." + "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-create-an-object-1483147613675", + "title": "To create an object." }, { "input": { - "Body": "HappyFace.jpg", + "Body": "c:\\HappyFace.jpg", "Bucket": "examplebucket", "Key": "HappyFace.jpg", - "ServerSideEncryption": "AES256", - "StorageClass": "STANDARD_IA" + "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256", - "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" + "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" }, "comments": { "input": { @@ -1625,22 +1625,22 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", - "id": "to-upload-an-object-(specify-optional-headers)", - "title": "To upload an object (specify optional headers)" + "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", + "title": "To upload an object and specify optional tags" }, { "input": { - "Body": "filetoupload", + "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "exampleobject", + "Key": "HappyFace.jpg", "ServerSideEncryption": "AES256", - "Tagging": "key1=value1&key2=value2" + "StorageClass": "STANDARD_IA" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", "ServerSideEncryption": "AES256", - "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" + "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" }, "comments": { "input": { @@ -1648,19 +1648,23 @@ "output": { } }, - "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", - "title": "To upload an object and specify server-side encryption and object tags" + "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", + "id": "to-upload-an-object-(specify-optional-headers)", + "title": "To upload an object (specify optional headers)" }, { "input": { "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "objectkey" + "Key": "exampleobject", + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" }, "comments": { "input": { @@ -1668,23 +1672,20 @@ "output": { } }, - "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-create-an-object-1483147613675", - "title": "To create an object." + "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", + "title": "To upload object and specify user-defined metadata" }, { "input": { + "ACL": "authenticated-read", "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "exampleobject", - "Metadata": { - "metadata1": "value1", - "metadata2": "value2" - } + "Key": "exampleobject" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" }, "comments": { "input": { @@ -1692,20 +1693,19 @@ "output": { } }, - "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", - "title": "To upload object and specify user-defined metadata" + "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", + "title": "To upload an object and specify canned ACL." }, { "input": { - "Body": "c:\\HappyFace.jpg", + "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "Tagging": "key1=value1&key2=value2" + "Key": "HappyFace.jpg" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" }, "comments": { "input": { @@ -1713,9 +1713,9 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", - "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", - "title": "To upload an object and specify optional tags" + "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", + "id": "to-upload-an-object-1481760101010", + "title": "To upload an object" } ], "PutObjectAcl": [ diff --git a/models/apis/securityhub/2018-10-26/docs-2.json b/models/apis/securityhub/2018-10-26/docs-2.json index 0185a9ad5b5..894b1871587 100644 --- a/models/apis/securityhub/2018-10-26/docs-2.json +++ b/models/apis/securityhub/2018-10-26/docs-2.json @@ -5,7 +5,7 @@ "AcceptInvitation": "

Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from.

This operation is only used by member accounts that are not added through Organizations.

When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.

", "BatchDisableStandards": "

Disables the standards specified by the provided StandardsSubscriptionArns.

For more information, see Security Standards section of the AWS Security Hub User Guide.

", "BatchEnableStandards": "

Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation.

For more information, see the Security Standards section of the AWS Security Hub User Guide.

", - "BatchImportFindings": "

Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.

", + "BatchImportFindings": "

Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.

BatchImportFindings can be used to update the following finding fields and objects only if they have not been updated using BatchUpdateFindings. After they are updated using BatchUpdateFindings, these fields cannot be updated using BatchImportFindings.

", "BatchUpdateFindings": "

Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.

Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.

Master and member accounts can use BatchUpdateFindings to update the following finding fields and objects.

You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the AWS Security Hub User Guide.

", "CreateActionTarget": "

Creates a custom action target in Security Hub.

You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

", "CreateInsight": "

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.

To group the related findings in the insight, use the GroupByAttribute.

", @@ -3400,7 +3400,7 @@ } }, "Severity": { - "base": "

The severity of the finding.

The finding provider can provide the initial severity, but cannot update it after that. The severity can only be updated by a master account. It cannot be updated by a member account.

The finding must have either Label or Normalized populated. If only one of these attributes is populated, then Security Hub automatically populates the other one. If neither attribute is populated, then the finding is invalid. Label is the preferred attribute.

", + "base": "

The severity of the finding.

The finding provider can provide the initial severity. The finding provider can only update the severity if it has not been updated using BatchUpdateFindings.

The finding must have either Label or Normalized populated. If only one of these attributes is populated, then Security Hub automatically populates the other one. If neither attribute is populated, then the finding is invalid. Label is the preferred attribute.

", "refs": { "AwsSecurityFinding$Severity": "

A finding's severity.

" } diff --git a/models/apis/service-quotas/2019-06-24/api-2.json b/models/apis/service-quotas/2019-06-24/api-2.json index 6ceb15dcac9..e9f2f85a142 100644 --- a/models/apis/service-quotas/2019-06-24/api-2.json +++ b/models/apis/service-quotas/2019-06-24/api-2.json @@ -260,6 +260,22 @@ {"shape":"TooManyRequestsException"} ] }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceException"} + ] + }, "PutServiceQuotaIncreaseRequestIntoTemplate":{ "name":"PutServiceQuotaIncreaseRequestIntoTemplate", "http":{ @@ -300,6 +316,40 @@ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"TooManyTagsException"}, + {"shape":"TagPolicyViolationException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceException"} + ] } }, "shapes":{ @@ -317,6 +367,12 @@ }, "exception":true }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"arn:aws(-[\\w]+)*:*:.+:[0-9]{12}:.+" + }, "AssociateServiceQuotaTemplateRequest":{ "type":"structure", "members":{ @@ -473,6 +529,15 @@ }, "exception":true }, + "InputTagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "InputTags":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, "InvalidPaginationTokenException":{ "type":"structure", "members":{ @@ -586,6 +651,19 @@ "Services":{"shape":"ServiceInfoListDefinition"} } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{"shape":"AmazonResourceName"} + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{"shape":"OutputTags"} + } + }, "MaxResults":{ "type":"integer", "max":100, @@ -634,6 +712,11 @@ }, "exception":true }, + "OutputTags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200 + }, "PeriodUnit":{ "type":"string", "enum":[ @@ -849,6 +932,52 @@ "min":1, "pattern":"(Sum|Maximum)" }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagPolicyViolationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "exception":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{"shape":"AmazonResourceName"}, + "Tags":{"shape":"InputTags"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, "TemplatesNotAvailableInRegionException":{ "type":"structure", "members":{ @@ -862,6 +991,29 @@ "Message":{"shape":"ExceptionMessage"} }, "exception":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{"shape":"AmazonResourceName"}, + "TagKeys":{"shape":"InputTagKeys"} + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } } } } diff --git a/models/apis/service-quotas/2019-06-24/docs-2.json b/models/apis/service-quotas/2019-06-24/docs-2.json index be0029d27f9..3978240534e 100644 --- a/models/apis/service-quotas/2019-06-24/docs-2.json +++ b/models/apis/service-quotas/2019-06-24/docs-2.json @@ -1,35 +1,46 @@ { "version": "2.0", - "service": "

Service Quotas is a web service that you can use to manage many of your AWS service quotas. Quotas, also referred to as limits, are the maximum values for a resource, item, or operation. This guide provide descriptions of the Service Quotas actions that you can call from an API. For the Service Quotas user guide, which explains how to use Service Quotas from the console, see What is Service Quotas.

AWS provides SDKs that consist of libraries and sample code for programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc...,). The SDKs provide a convenient way to create programmatic access to Service Quotas and AWS. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

", + "service": "

With Service Quotas, you can view and manage your quotas easily as your AWS workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your AWS account. For more information, see the Service Quotas User Guide.

", "operations": { - "AssociateServiceQuotaTemplate": "

Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template.

", - "DeleteServiceQuotaIncreaseRequestFromTemplate": "

Removes a service quota increase request from the Service Quotas template.

", - "DisassociateServiceQuotaTemplate": "

Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template.

Related operations

", - "GetAWSDefaultServiceQuota": "

Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..

", - "GetAssociationForServiceQuotaTemplate": "

Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.

", - "GetRequestedServiceQuotaChange": "

Retrieves the details for a particular increase request.

", - "GetServiceQuota": "

Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.

", - "GetServiceQuotaIncreaseRequestFromTemplate": "

Returns the details of the service quota increase request in your template.

", - "ListAWSDefaultServiceQuotas": "

Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you'll see the default values are the values that AWS provides for the quotas.

Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

", - "ListRequestedServiceQuotaChangeHistory": "

Requests a list of the changes to quotas for a service.

", - "ListRequestedServiceQuotaChangeHistoryByQuota": "

Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.

", - "ListServiceQuotaIncreaseRequestsInTemplate": "

Returns a list of the quota increase requests in the template.

", - "ListServiceQuotas": "

Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas.

Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

", - "ListServices": "

Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.

", - "PutServiceQuotaIncreaseRequestIntoTemplate": "

Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the template.

", - "RequestServiceQuotaIncrease": "

Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.

" + "AssociateServiceQuotaTemplate": "

Associates your quota request template with your organization. When a new account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.

", + "DeleteServiceQuotaIncreaseRequestFromTemplate": "

Deletes the quota increase request for the specified quota from your quota request template.

", + "DisassociateServiceQuotaTemplate": "

Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new accounts in your organization. Disabling a quota request template does not apply its quota increase requests.

", + "GetAWSDefaultServiceQuota": "

Retrieves the default value for the specified quota. The default value does not reflect any quota increases.

", + "GetAssociationForServiceQuotaTemplate": "

Retrieves the status of the association for the quota request template.

", + "GetRequestedServiceQuotaChange": "

Retrieves information about the specified quota increase request.

", + "GetServiceQuota": "

Retrieves the applied quota value for the specified quota. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.

", + "GetServiceQuotaIncreaseRequestFromTemplate": "

Retrieves information about the specified quota increase request in your quota request template.

", + "ListAWSDefaultServiceQuotas": "

Lists the default values for the quotas for the specified AWS service. A default value does not reflect any quota increases.

", + "ListRequestedServiceQuotaChangeHistory": "

Retrieves the quota increase requests for the specified service.

", + "ListRequestedServiceQuotaChangeHistoryByQuota": "

Retrieves the quota increase requests for the specified quota.

", + "ListServiceQuotaIncreaseRequestsInTemplate": "

Lists the quota increase requests in the specified quota request template.

", + "ListServiceQuotas": "

Lists the applied quota values for the specified AWS service. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.

", + "ListServices": "

Lists the names and codes for the services integrated with Service Quotas.

", + "ListTagsForResource": "

Returns a list of the tags assigned to the specified applied quota.

", + "PutServiceQuotaIncreaseRequestIntoTemplate": "

Adds a quota increase request to your quota request template.

", + "RequestServiceQuotaIncrease": "

Submits a quota increase request for the specified quota.

", + "TagResource": "

Adds tags to the specified applied quota. You can include one or more tags to add to the quota.

", + "UntagResource": "

Removes tags from the specified applied quota. You can specify one or more tags to remove.

" }, "shapes": { "AWSServiceAccessNotEnabledException": { - "base": "

The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate.

", + "base": "

The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.

", "refs": { } }, "AccessDeniedException": { - "base": "

You do not have sufficient access to perform this action.

", + "base": "

You do not have sufficient permission to perform this action.

", "refs": { } }, + "AmazonResourceName": { + "base": null, + "refs": { + "ListTagsForResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) for the applied quota for which you want to list tags. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

", + "TagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) for the applied quota. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

", + "UntagResourceRequest$ResourceARN": "

The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

" + } + }, "AssociateServiceQuotaTemplateRequest": { "base": null, "refs": { @@ -43,24 +54,24 @@ "AwsRegion": { "base": null, "refs": { - "DeleteServiceQuotaIncreaseRequestFromTemplateRequest$AwsRegion": "

Specifies the AWS Region for the quota that you want to delete.

", - "GetServiceQuotaIncreaseRequestFromTemplateRequest$AwsRegion": "

Specifies the AWS Region for the quota that you want to use.

", - "ListServiceQuotaIncreaseRequestsInTemplateRequest$AwsRegion": "

Specifies the AWS Region for the quota that you want to use.

", - "PutServiceQuotaIncreaseRequestIntoTemplateRequest$AwsRegion": "

Specifies the AWS Region for the quota.

", - "ServiceQuotaIncreaseRequestInTemplate$AwsRegion": "

The AWS Region where the increase request occurs.

" + "DeleteServiceQuotaIncreaseRequestFromTemplateRequest$AwsRegion": "

The AWS Region.

", + "GetServiceQuotaIncreaseRequestFromTemplateRequest$AwsRegion": "

The AWS Region.

", + "ListServiceQuotaIncreaseRequestsInTemplateRequest$AwsRegion": "

The AWS Region.

", + "PutServiceQuotaIncreaseRequestIntoTemplateRequest$AwsRegion": "

The AWS Region.

", + "ServiceQuotaIncreaseRequestInTemplate$AwsRegion": "

The AWS Region.

" } }, "CustomerServiceEngagementId": { "base": null, "refs": { - "RequestedServiceQuotaChange$CaseId": "

The case Id for the service quota increase request.

" + "RequestedServiceQuotaChange$CaseId": "

The case ID.

" } }, "DateTime": { "base": null, "refs": { - "RequestedServiceQuotaChange$Created": "

The date and time when the service quota increase request was received and the case Id was created.

", - "RequestedServiceQuotaChange$LastUpdated": "

The date and time of the most recent change in the service quota increase request.

" + "RequestedServiceQuotaChange$Created": "

The date and time when the quota increase request was received and the case ID was created.

", + "RequestedServiceQuotaChange$LastUpdated": "

The date and time of the most recent change.

" } }, "DeleteServiceQuotaIncreaseRequestFromTemplateRequest": { @@ -91,19 +102,19 @@ "ErrorCode": { "base": null, "refs": { - "ErrorReason$ErrorCode": "

Service Quotas returns the following error values.

DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

" + "ErrorReason$ErrorCode": "

Service Quotas returns the following error values:

" } }, "ErrorMessage": { "base": null, "refs": { - "ErrorReason$ErrorMessage": "

The error message that provides more detail.

" + "ErrorReason$ErrorMessage": "

The error message.

" } }, "ErrorReason": { - "base": "

Returns an error that explains why the action did not succeed.

", + "base": "

An error that explains why an action did not succeed.

", "refs": { - "ServiceQuota$ErrorReason": "

Specifies the ErrorCode and ErrorMessage when success isn't achieved.

" + "ServiceQuota$ErrorReason": "

The error code and error reason.

" } }, "ExceptionMessage": { @@ -122,8 +133,10 @@ "ResourceAlreadyExistsException$Message": null, "ServiceException$Message": null, "ServiceQuotaTemplateNotInUseException$Message": null, + "TagPolicyViolationException$Message": null, "TemplatesNotAvailableInRegionException$Message": null, - "TooManyRequestsException$Message": null + "TooManyRequestsException$Message": null, + "TooManyTagsException$Message": null } }, "GetAWSDefaultServiceQuotaRequest": { @@ -179,23 +192,35 @@ "GlobalQuota": { "base": null, "refs": { - "RequestedServiceQuotaChange$GlobalQuota": "

Identifies if the quota is global.

", - "ServiceQuota$GlobalQuota": "

Specifies if the quota is global.

", - "ServiceQuotaIncreaseRequestInTemplate$GlobalQuota": "

Specifies if the quota is a global quota.

" + "RequestedServiceQuotaChange$GlobalQuota": "

Indicates whether the quota is global.

", + "ServiceQuota$GlobalQuota": "

Indicates whether the quota is global.

", + "ServiceQuotaIncreaseRequestInTemplate$GlobalQuota": "

Indicates whether the quota is global.

" } }, "IllegalArgumentException": { - "base": "

Invalid input was provided.

", + "base": "

Invalid input was provided.

", "refs": { } }, + "InputTagKeys": { + "base": null, + "refs": { + "UntagResourceRequest$TagKeys": "

The keys of the tags that you want to remove from the resource.

" + } + }, + "InputTags": { + "base": null, + "refs": { + "TagResourceRequest$Tags": "

The tags that you want to add to the resource.

" + } + }, "InvalidPaginationTokenException": { "base": "

Invalid input was provided.

", "refs": { } }, "InvalidResourceStateException": { - "base": "

Invalid input was provided for the .

", + "base": "

The resource is in an invalid state.

", "refs": { } }, @@ -259,15 +284,25 @@ "refs": { } }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, "MaxResults": { "base": null, "refs": { - "ListAWSDefaultServiceQuotasRequest$MaxResults": "

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

", - "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$MaxResults": "

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

", - "ListRequestedServiceQuotaChangeHistoryRequest$MaxResults": "

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

", - "ListServiceQuotaIncreaseRequestsInTemplateRequest$MaxResults": "

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

", - "ListServiceQuotasRequest$MaxResults": "

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

", - "ListServicesRequest$MaxResults": "

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

" + "ListAWSDefaultServiceQuotasRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.

", + "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.

", + "ListRequestedServiceQuotaChangeHistoryRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.

", + "ListServiceQuotaIncreaseRequestsInTemplateRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.

", + "ListServiceQuotasRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.

", + "ListServicesRequest$MaxResults": "

The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.

" } }, "MetricDimensionName": { @@ -285,30 +320,30 @@ "MetricDimensionsMapDefinition": { "base": null, "refs": { - "MetricInfo$MetricDimensions": "

A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

" + "MetricInfo$MetricDimensions": "

The metric dimension. This is a name/value pair that is part of the identity of a metric.

" } }, "MetricInfo": { - "base": "

A structure that uses CloudWatch metrics to gather data about the service quota.

", + "base": "

Information about the CloudWatch metric that reflects quota usage.

", "refs": { - "ServiceQuota$UsageMetric": "

Specifies the details about the measurement.

" + "ServiceQuota$UsageMetric": "

Information about the measurement.

" } }, "NextToken": { "base": null, "refs": { - "ListAWSDefaultServiceQuotasRequest$NextToken": "

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

", - "ListAWSDefaultServiceQuotasResponse$NextToken": "

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

", - "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$NextToken": "

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

", - "ListRequestedServiceQuotaChangeHistoryByQuotaResponse$NextToken": "

If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

", - "ListRequestedServiceQuotaChangeHistoryRequest$NextToken": "

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

", - "ListRequestedServiceQuotaChangeHistoryResponse$NextToken": "

If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

", - "ListServiceQuotaIncreaseRequestsInTemplateRequest$NextToken": "

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

", - "ListServiceQuotaIncreaseRequestsInTemplateResponse$NextToken": "

If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

", - "ListServiceQuotasRequest$NextToken": "

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

", - "ListServiceQuotasResponse$NextToken": "

If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

", - "ListServicesRequest$NextToken": "

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

", - "ListServicesResponse$NextToken": "

If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

" + "ListAWSDefaultServiceQuotasRequest$NextToken": "

The token for the next page of results.

", + "ListAWSDefaultServiceQuotasResponse$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$NextToken": "

The token for the next page of results.

", + "ListRequestedServiceQuotaChangeHistoryByQuotaResponse$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "ListRequestedServiceQuotaChangeHistoryRequest$NextToken": "

The token for the next page of results.

", + "ListRequestedServiceQuotaChangeHistoryResponse$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "ListServiceQuotaIncreaseRequestsInTemplateRequest$NextToken": "

The token for the next page of results.

", + "ListServiceQuotaIncreaseRequestsInTemplateResponse$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "ListServiceQuotasRequest$NextToken": "

The token for the next page of results.

", + "ListServiceQuotasResponse$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "ListServicesRequest$NextToken": "

The token for the next page of results.

", + "ListServicesResponse$NextToken": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" } }, "NoAvailableOrganizationException": { @@ -322,20 +357,26 @@ } }, "OrganizationNotInAllFeaturesModeException": { - "base": "

The organization that your account belongs to, is not in All Features mode. To enable all features mode, see EnableAllFeatures.

", + "base": "

The organization that your account belongs to is not in All Features mode.

", + "refs": { + } + }, + "OutputTags": { + "base": null, "refs": { + "ListTagsForResourceResponse$Tags": "

A complex data type that contains zero or more tag elements.

" } }, "PeriodUnit": { "base": null, "refs": { - "QuotaPeriod$PeriodUnit": "

The time unit of a period.

" + "QuotaPeriod$PeriodUnit": "

The time unit.

" } }, "PeriodValue": { "base": null, "refs": { - "QuotaPeriod$PeriodValue": "

The value of a period.

" + "QuotaPeriod$PeriodValue": "

The value.

" } }, "PutServiceQuotaIncreaseRequestIntoTemplateRequest": { @@ -351,29 +392,29 @@ "QuotaAdjustable": { "base": null, "refs": { - "ServiceQuota$Adjustable": "

Specifies if the quota value can be increased.

" + "ServiceQuota$Adjustable": "

Indicates whether the quota value can be increased.

" } }, "QuotaArn": { "base": null, "refs": { - "RequestedServiceQuotaChange$QuotaArn": "

The Amazon Resource Name (ARN) of the service quota.

", - "ServiceQuota$QuotaArn": "

The Amazon Resource Name (ARN) of the service quota.

" + "RequestedServiceQuotaChange$QuotaArn": "

The Amazon Resource Name (ARN) of the quota.

", + "ServiceQuota$QuotaArn": "

The Amazon Resource Name (ARN) of the quota.

" } }, "QuotaCode": { "base": null, "refs": { - "DeleteServiceQuotaIncreaseRequestFromTemplateRequest$QuotaCode": "

Specifies the code for the quota that you want to delete.

", - "GetAWSDefaultServiceQuotaRequest$QuotaCode": "

Identifies the service quota you want to select.

", - "GetServiceQuotaIncreaseRequestFromTemplateRequest$QuotaCode": "

Specifies the quota you want.

", - "GetServiceQuotaRequest$QuotaCode": "

Identifies the service quota you want to select.

", - "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$QuotaCode": "

Specifies the service quota that you want to use

", - "PutServiceQuotaIncreaseRequestIntoTemplateRequest$QuotaCode": "

Specifies the service quota that you want to use.

", - "RequestServiceQuotaIncreaseRequest$QuotaCode": "

Specifies the service quota that you want to use.

", - "RequestedServiceQuotaChange$QuotaCode": "

Specifies the service quota that you want to use.

", - "ServiceQuota$QuotaCode": "

The code identifier for the service quota specified.

", - "ServiceQuotaIncreaseRequestInTemplate$QuotaCode": "

The code identifier for the service quota specified in the increase request.

" + "DeleteServiceQuotaIncreaseRequestFromTemplateRequest$QuotaCode": "

The quota identifier.

", + "GetAWSDefaultServiceQuotaRequest$QuotaCode": "

The quota identifier.

", + "GetServiceQuotaIncreaseRequestFromTemplateRequest$QuotaCode": "

The quota identifier.

", + "GetServiceQuotaRequest$QuotaCode": "

The quota identifier.

", + "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$QuotaCode": "

The quota identifier.

", + "PutServiceQuotaIncreaseRequestIntoTemplateRequest$QuotaCode": "

The quota identifier.

", + "RequestServiceQuotaIncreaseRequest$QuotaCode": "

The quota identifier.

", + "RequestedServiceQuotaChange$QuotaCode": "

The quota identifier.

", + "ServiceQuota$QuotaCode": "

The quota identifier.

", + "ServiceQuotaIncreaseRequestInTemplate$QuotaCode": "

The quota identifier.

" } }, "QuotaExceededException": { @@ -384,52 +425,52 @@ "QuotaMetricName": { "base": null, "refs": { - "MetricInfo$MetricName": "

The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

" + "MetricInfo$MetricName": "

The name of the metric.

" } }, "QuotaMetricNamespace": { "base": null, "refs": { - "MetricInfo$MetricNamespace": "

The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

" + "MetricInfo$MetricNamespace": "

The namespace of the metric.

" } }, "QuotaName": { "base": null, "refs": { - "RequestedServiceQuotaChange$QuotaName": "

Name of the service quota.

", - "ServiceQuota$QuotaName": "

The name identifier of the service quota.

", - "ServiceQuotaIncreaseRequestInTemplate$QuotaName": "

The name of the service quota in the increase request.

" + "RequestedServiceQuotaChange$QuotaName": "

The quota name.

", + "ServiceQuota$QuotaName": "

The quota name.

", + "ServiceQuotaIncreaseRequestInTemplate$QuotaName": "

The quota name.

" } }, "QuotaPeriod": { - "base": "

A structure that contains information about the quota period.

", + "base": "

Information about the quota period.

", "refs": { - "ServiceQuota$Period": "

Identifies the unit and value of how time is measured.

" + "ServiceQuota$Period": "

The period of time.

" } }, "QuotaUnit": { "base": null, "refs": { - "RequestedServiceQuotaChange$Unit": "

Specifies the unit used for the quota.

", - "ServiceQuota$Unit": "

The unit of measurement for the value of the service quota.

", - "ServiceQuotaIncreaseRequestInTemplate$Unit": "

The unit of measure for the increase request.

" + "RequestedServiceQuotaChange$Unit": "

The unit of measurement.

", + "ServiceQuota$Unit": "

The unit of measurement.

", + "ServiceQuotaIncreaseRequestInTemplate$Unit": "

The unit of measurement.

" } }, "QuotaValue": { "base": null, "refs": { - "PutServiceQuotaIncreaseRequestIntoTemplateRequest$DesiredValue": "

Specifies the new, increased value for the quota.

", - "RequestServiceQuotaIncreaseRequest$DesiredValue": "

Specifies the value submitted in the service quota increase request.

", - "RequestedServiceQuotaChange$DesiredValue": "

New increased value for the service quota.

", - "ServiceQuota$Value": "

The value of service quota.

", - "ServiceQuotaIncreaseRequestInTemplate$DesiredValue": "

Identifies the new, increased value of the service quota in the increase request.

" + "PutServiceQuotaIncreaseRequestIntoTemplateRequest$DesiredValue": "

The new, increased value for the quota.

", + "RequestServiceQuotaIncreaseRequest$DesiredValue": "

The new, increased value for the quota.

", + "RequestedServiceQuotaChange$DesiredValue": "

The new, increased value for the quota.

", + "ServiceQuota$Value": "

The quota value.

", + "ServiceQuotaIncreaseRequestInTemplate$DesiredValue": "

The new, increased value of the quota.

" } }, "RequestId": { "base": null, "refs": { - "GetRequestedServiceQuotaChangeRequest$RequestId": "

Identifies the quota increase request.

", - "RequestedServiceQuotaChange$Id": "

The unique identifier of a requested service quota change.

" + "GetRequestedServiceQuotaChangeRequest$RequestId": "

The ID of the quota increase request.

", + "RequestedServiceQuotaChange$Id": "

The unique identifier.

" } }, "RequestServiceQuotaIncreaseRequest": { @@ -445,30 +486,30 @@ "RequestStatus": { "base": null, "refs": { - "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$Status": "

Specifies the status value of the quota increase request.

", - "ListRequestedServiceQuotaChangeHistoryRequest$Status": "

Specifies the status value of the quota increase request.

", - "RequestedServiceQuotaChange$Status": "

State of the service quota increase request.

" + "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$Status": "

The status value of the quota increase request.

", + "ListRequestedServiceQuotaChangeHistoryRequest$Status": "

The status of the quota increase request.

", + "RequestedServiceQuotaChange$Status": "

The state of the quota increase request.

" } }, "RequestedServiceQuotaChange": { - "base": "

A structure that contains information about a requested change for a quota.

", + "base": "

Information about a quota increase request.

", "refs": { - "GetRequestedServiceQuotaChangeResponse$RequestedQuota": "

Returns the RequestedServiceQuotaChange object for the specific increase request.

", - "RequestServiceQuotaIncreaseResponse$RequestedQuota": "

Returns a list of service quota requests.

", + "GetRequestedServiceQuotaChangeResponse$RequestedQuota": "

Information about the quota increase request.

", + "RequestServiceQuotaIncreaseResponse$RequestedQuota": "

Information about the quota increase request.

", "RequestedServiceQuotaChangeHistoryListDefinition$member": null } }, "RequestedServiceQuotaChangeHistoryListDefinition": { "base": null, "refs": { - "ListRequestedServiceQuotaChangeHistoryByQuotaResponse$RequestedQuotas": "

Returns a list of service quota requests.

", - "ListRequestedServiceQuotaChangeHistoryResponse$RequestedQuotas": "

Returns a list of service quota requests.

" + "ListRequestedServiceQuotaChangeHistoryByQuotaResponse$RequestedQuotas": "

Information about the quota increase requests.

", + "ListRequestedServiceQuotaChangeHistoryResponse$RequestedQuotas": "

Information about the quota increase requests.

" } }, "Requester": { "base": null, "refs": { - "RequestedServiceQuotaChange$Requester": "

The IAM identity who submitted the service quota increase request.

" + "RequestedServiceQuotaChange$Requester": "

The IAM identity of the requester.

" } }, "ResourceAlreadyExistsException": { @@ -479,30 +520,30 @@ "ServiceCode": { "base": null, "refs": { - "DeleteServiceQuotaIncreaseRequestFromTemplateRequest$ServiceCode": "

Specifies the code for the service that you want to delete.

", - "GetAWSDefaultServiceQuotaRequest$ServiceCode": "

Specifies the service that you want to use.

", - "GetServiceQuotaIncreaseRequestFromTemplateRequest$ServiceCode": "

Specifies the service that you want to use.

", - "GetServiceQuotaRequest$ServiceCode": "

Specifies the service that you want to use.

", - "ListAWSDefaultServiceQuotasRequest$ServiceCode": "

Specifies the service that you want to use.

", - "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$ServiceCode": "

Specifies the service that you want to use.

", - "ListRequestedServiceQuotaChangeHistoryRequest$ServiceCode": "

Specifies the service that you want to use.

", - "ListServiceQuotaIncreaseRequestsInTemplateRequest$ServiceCode": "

The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.

", - "ListServiceQuotasRequest$ServiceCode": "

The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.

", - "PutServiceQuotaIncreaseRequestIntoTemplateRequest$ServiceCode": "

Specifies the service that you want to use.

", - "RequestServiceQuotaIncreaseRequest$ServiceCode": "

Specifies the service that you want to use.

", - "RequestedServiceQuotaChange$ServiceCode": "

Specifies the service that you want to use.

", - "ServiceInfo$ServiceCode": "

Specifies the service that you want to use.

", - "ServiceQuota$ServiceCode": "

Specifies the service that you want to use.

", - "ServiceQuotaIncreaseRequestInTemplate$ServiceCode": "

The code identifier for the AWS service specified in the increase request.

" + "DeleteServiceQuotaIncreaseRequestFromTemplateRequest$ServiceCode": "

The service identifier.

", + "GetAWSDefaultServiceQuotaRequest$ServiceCode": "

The service identifier.

", + "GetServiceQuotaIncreaseRequestFromTemplateRequest$ServiceCode": "

The service identifier.

", + "GetServiceQuotaRequest$ServiceCode": "

The service identifier.

", + "ListAWSDefaultServiceQuotasRequest$ServiceCode": "

The service identifier.

", + "ListRequestedServiceQuotaChangeHistoryByQuotaRequest$ServiceCode": "

The service identifier.

", + "ListRequestedServiceQuotaChangeHistoryRequest$ServiceCode": "

The service identifier.

", + "ListServiceQuotaIncreaseRequestsInTemplateRequest$ServiceCode": "

The service identifier.

", + "ListServiceQuotasRequest$ServiceCode": "

The service identifier.

", + "PutServiceQuotaIncreaseRequestIntoTemplateRequest$ServiceCode": "

The service identifier.

", + "RequestServiceQuotaIncreaseRequest$ServiceCode": "

The service identifier.

", + "RequestedServiceQuotaChange$ServiceCode": "

The service identifier.

", + "ServiceInfo$ServiceCode": "

The service identifier.

", + "ServiceQuota$ServiceCode": "

The service identifier.

", + "ServiceQuotaIncreaseRequestInTemplate$ServiceCode": "

The service identifier.

" } }, "ServiceException": { - "base": "

Something went wrong.

", + "base": "

Something went wrong.

", "refs": { } }, "ServiceInfo": { - "base": "

A structure that contains the ServiceName and ServiceCode. It does not include all details of the service quota. To get those values, use the ListServiceQuotas operation.

", + "base": "

Information about a service.

", "refs": { "ServiceInfoListDefinition$member": null } @@ -510,71 +551,121 @@ "ServiceInfoListDefinition": { "base": null, "refs": { - "ListServicesResponse$Services": "

Returns a list of services.

" + "ListServicesResponse$Services": "

Information about the services.

" } }, "ServiceName": { "base": null, "refs": { - "RequestedServiceQuotaChange$ServiceName": "

The name of the AWS service specified in the increase request.

", - "ServiceInfo$ServiceName": "

The name of the AWS service specified in the increase request.

", - "ServiceQuota$ServiceName": "

The name of the AWS service specified in the increase request.

", - "ServiceQuotaIncreaseRequestInTemplate$ServiceName": "

The name of the AWS service specified in the increase request.

" + "RequestedServiceQuotaChange$ServiceName": "

The service name.

", + "ServiceInfo$ServiceName": "

The service name.

", + "ServiceQuota$ServiceName": "

The service name.

", + "ServiceQuotaIncreaseRequestInTemplate$ServiceName": "

The service name.

" } }, "ServiceQuota": { - "base": "

A structure that contains the full set of details that define the service quota.

", + "base": "

Information about a quota.

", "refs": { - "GetAWSDefaultServiceQuotaResponse$Quota": "

Returns the ServiceQuota object which contains all values for a quota.

", - "GetServiceQuotaResponse$Quota": "

Returns the ServiceQuota object which contains all values for a quota.

", + "GetAWSDefaultServiceQuotaResponse$Quota": "

Information about the quota.

", + "GetServiceQuotaResponse$Quota": "

Information about the quota.

", "ServiceQuotaListDefinition$member": null } }, "ServiceQuotaIncreaseRequestInTemplate": { - "base": "

A structure that contains information about one service quota increase request.

", + "base": "

Information about a quota increase request.

", "refs": { - "GetServiceQuotaIncreaseRequestFromTemplateResponse$ServiceQuotaIncreaseRequestInTemplate": "

This object contains the details about the quota increase request.

", - "PutServiceQuotaIncreaseRequestIntoTemplateResponse$ServiceQuotaIncreaseRequestInTemplate": "

A structure that contains information about one service quota increase request.

", + "GetServiceQuotaIncreaseRequestFromTemplateResponse$ServiceQuotaIncreaseRequestInTemplate": "

Information about the quota increase request.

", + "PutServiceQuotaIncreaseRequestIntoTemplateResponse$ServiceQuotaIncreaseRequestInTemplate": "

Information about the quota increase request.

", "ServiceQuotaIncreaseRequestInTemplateList$member": null } }, "ServiceQuotaIncreaseRequestInTemplateList": { "base": null, "refs": { - "ListServiceQuotaIncreaseRequestsInTemplateResponse$ServiceQuotaIncreaseRequestInTemplateList": "

Returns the list of values of the quota increase request in the template.

" + "ListServiceQuotaIncreaseRequestsInTemplateResponse$ServiceQuotaIncreaseRequestInTemplateList": "

Information about the quota increase requests.

" } }, "ServiceQuotaListDefinition": { "base": null, "refs": { - "ListAWSDefaultServiceQuotasResponse$Quotas": "

A list of the quotas in the account with the AWS default values.

", - "ListServiceQuotasResponse$Quotas": "

The response information for a quota lists all attribute information for the quota.

" + "ListAWSDefaultServiceQuotasResponse$Quotas": "

Information about the quotas.

", + "ListServiceQuotasResponse$Quotas": "

Information about the quotas.

" } }, "ServiceQuotaTemplateAssociationStatus": { "base": null, "refs": { - "GetAssociationForServiceQuotaTemplateResponse$ServiceQuotaTemplateAssociationStatus": "

Specifies whether the template is ASSOCIATED or DISASSOCIATED. If the template is ASSOCIATED, then it requests service quota increases for all new accounts created in your organization.

" + "GetAssociationForServiceQuotaTemplateResponse$ServiceQuotaTemplateAssociationStatus": "

The association status. If the status is ASSOCIATED, the quota increase requests in the template are automatically applied to new accounts in your organization.

" } }, "ServiceQuotaTemplateNotInUseException": { - "base": "

The quota request template is not associated with your organization.

To use the template, call AssociateServiceQuotaTemplate.

", + "base": "

The quota request template is not associated with your organization.

", "refs": { } }, "Statistic": { "base": null, "refs": { - "MetricInfo$MetricStatisticRecommendation": "

Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

" + "MetricInfo$MetricStatisticRecommendation": "

The metric statistic that we recommend you use when determining quota usage.

" + } + }, + "Tag": { + "base": "

A complex data type that contains a tag key and tag value.

", + "refs": { + "InputTags$member": null, + "OutputTags$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "InputTagKeys$member": null, + "Tag$Key": "

A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "TagPolicyViolationException": { + "base": "

The specified tag is a reserved word and cannot be used.

", + "refs": { + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "

A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" } }, "TemplatesNotAvailableInRegionException": { - "base": "

The Service Quotas template is not available in the Region where you are making the request. Please make the request in us-east-1.

", + "base": "

The Service Quotas template is not available in this AWS Region.

", "refs": { } }, "TooManyRequestsException": { - "base": "

Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.

", + "base": "

Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.

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

You've exceeded the number of tags allowed for a resource. For more information, see Tag restrictions in the Service Quotas User Guide.

", + "refs": { + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, "refs": { } } diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json b/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json index e9c720758a1..ce534f785f5 100644 --- a/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json +++ b/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json @@ -229,6 +229,20 @@ {"shape":"InternalServerException"} ] }, + "SyncResource":{ + "name":"SyncResource", + "http":{ + "method":"POST", + "requestUri":"/sync/{resourceType}/{resource}" + }, + "input":{"shape":"SyncResourceRequest"}, + "output":{"shape":"SyncResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ] + }, "TagResource":{ "name":"TagResource", "http":{ @@ -843,6 +857,40 @@ "pattern":"arn:aws[-a-z]*:cloudformation:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:stack/[a-zA-Z][-A-Za-z0-9]{0,127}/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}" }, "String":{"type":"string"}, + "SyncAction":{ + "type":"string", + "enum":[ + "START_SYNC", + "NO_ACTION" + ] + }, + "SyncResourceRequest":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"ResourceType", + "location":"uri", + "locationName":"resourceType" + }, + "resource":{ + "shape":"ResourceSpecifier", + "location":"uri", + "locationName":"resource" + } + } + }, + "SyncResourceResponse":{ + "type":"structure", + "members":{ + "applicationArn":{"shape":"ApplicationArn"}, + "resourceArn":{"shape":"Arn"}, + "actionTaken":{"shape":"SyncAction"} + } + }, "TagKey":{ "type":"string", "max":128, diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json b/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json index 80bc8f3f84f..5e690ca5d35 100644 --- a/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json +++ b/models/apis/servicecatalog-appregistry/2020-06-24/docs-2.json @@ -17,8 +17,9 @@ "ListAssociatedResources": "

Lists all resources that are associated with specified application. Results are paginated.

", "ListAttributeGroups": "

Lists all attribute groups which you have access to. Results are paginated.

", "ListTagsForResource": "

Lists all of the tags on the resource.

", - "TagResource": "

Assigns one or more tags (key-value pairs) to the specified resource.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

", - "UntagResource": "

Removes tags from a resource.

", + "SyncResource": "

Syncs the resource with what is currently recorded in App registry. Specifically, the resource’s App registry system tags are synced with its associated application. The resource is removed if it is not associated with the application. The caller must have permissions to read and update the resource.

", + "TagResource": "

Assigns one or more tags (key-value pairs) to the specified resource.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

This operation returns an empty response if the call was successful.

", + "UntagResource": "

Removes tags from a resource.

This operation returns an empty response if the call was successful.

", "UpdateApplication": "

Updates an existing application with new attributes.

", "UpdateAttributeGroup": "

Updates an existing attribute group with new details.

" }, @@ -39,7 +40,8 @@ "AssociateResourceResponse$applicationArn": "

The Amazon resource name (ARN) of the application that was augmented with attributes.

", "DisassociateAttributeGroupResponse$applicationArn": "

The Amazon resource name (ARN) that specifies the application.

", "DisassociateResourceResponse$applicationArn": "

The Amazon resource name (ARN) that specifies the application.

", - "GetApplicationResponse$arn": "

The Amazon resource name (ARN) that specifies the application across services.

" + "GetApplicationResponse$arn": "

The Amazon resource name (ARN) that specifies the application across services.

", + "SyncResourceResponse$applicationArn": "

The Amazon resource name (ARN) that specifies the application.

" } }, "ApplicationId": { @@ -83,6 +85,7 @@ "AssociateResourceResponse$resourceArn": "

The Amazon resource name (ARN) that specifies the resource.

", "DisassociateResourceResponse$resourceArn": "

The Amazon resource name (ARN) that specifies the resource.

", "ListTagsForResourceRequest$resourceArn": "

The Amazon resource name (ARN) that specifies the resource.

", + "SyncResourceResponse$resourceArn": "

The Amazon resource name (ARN) that specifies the resource.

", "TagResourceRequest$resourceArn": "

The Amazon resource name (ARN) that specifies the resource.

", "UntagResourceRequest$resourceArn": "

The Amazon resource name (ARN) that specifies the resource.

" } @@ -391,14 +394,16 @@ "refs": { "AssociateResourceRequest$resource": "

The name or ID of the resource of which the application will be associated.

", "DisassociateResourceRequest$resource": "

The name or ID of the resource.

", - "ResourceInfo$name": "

The name of the resource.

" + "ResourceInfo$name": "

The name of the resource.

", + "SyncResourceRequest$resource": "

An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an AWS CloudFormation stack, or an Amazon S3 bucket.

" } }, "ResourceType": { "base": null, "refs": { "AssociateResourceRequest$resourceType": "

The type of resource of which the application will be associated.

", - "DisassociateResourceRequest$resourceType": "

The type of the resource that is being disassociated.

" + "DisassociateResourceRequest$resourceType": "

The type of the resource that is being disassociated.

", + "SyncResourceRequest$resourceType": "

The type of resource of which the application will be associated.

" } }, "Resources": { @@ -428,6 +433,22 @@ "ValidationException$message": null } }, + "SyncAction": { + "base": null, + "refs": { + "SyncResourceResponse$actionTaken": "

The results of the output if an application is associated with an ARN value, which could be syncStarted or None.

" + } + }, + "SyncResourceRequest": { + "base": null, + "refs": { + } + }, + "SyncResourceResponse": { + "base": null, + "refs": { + } + }, "TagKey": { "base": null, "refs": { diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 7f8501728cb..038c53e7cce 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -8172,6 +8172,24 @@ "us-gov-west-1" : { } } }, + "fsx" : { + "endpoints" : { + "fips-prod-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "fsx-fips.us-gov-east-1.amazonaws.com" + }, + "fips-prod-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "fsx-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "glacier" : { "endpoints" : { "us-gov-east-1" : { diff --git a/service/apigateway/api.go b/service/apigateway/api.go index 3828b7e94cb..313943be95c 100644 --- a/service/apigateway/api.go +++ b/service/apigateway/api.go @@ -22145,8 +22145,8 @@ type QuotaSettings struct { // The maximum number of requests that can be made in a given time period. Limit *int64 `locationName:"limit" type:"integer"` - // The number of requests subtracted from the given limit in the initial time - // period. + // The day that a time period starts. For example, with a time period of WEEK, + // an offset of 0 starts on Sunday, and an offset of 1 starts on Monday. Offset *int64 `locationName:"offset" type:"integer"` // The time period in which the limit applies. Valid values are "DAY", "WEEK" diff --git a/service/appregistry/api.go b/service/appregistry/api.go index 64f1852240d..385687e40dd 100644 --- a/service/appregistry/api.go +++ b/service/appregistry/api.go @@ -1545,6 +1545,95 @@ func (c *AppRegistry) ListTagsForResourceWithContext(ctx aws.Context, input *Lis return out, req.Send() } +const opSyncResource = "SyncResource" + +// SyncResourceRequest generates a "aws/request.Request" representing the +// client's request for the SyncResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See SyncResource for more information on using the SyncResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the SyncResourceRequest method. +// req, resp := client.SyncResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/AWS242AppRegistry-2020-06-24/SyncResource +func (c *AppRegistry) SyncResourceRequest(input *SyncResourceInput) (req *request.Request, output *SyncResourceOutput) { + op := &request.Operation{ + Name: opSyncResource, + HTTPMethod: "POST", + HTTPPath: "/sync/{resourceType}/{resource}", + } + + if input == nil { + input = &SyncResourceInput{} + } + + output = &SyncResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// SyncResource API operation for AWS Service Catalog App Registry. +// +// Syncs the resource with what is currently recorded in App registry. Specifically, +// the resource’s App registry system tags are synced with its associated +// application. The resource is removed if it is not associated with the application. +// The caller must have permissions to read and update the resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Service Catalog App Registry's +// API operation SyncResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * InternalServerException +// The service is experiencing internal problems. +// +// * ConflictException +// There was a conflict when processing the request (for example, a resource +// with the given name already exists within the account). +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/AWS242AppRegistry-2020-06-24/SyncResource +func (c *AppRegistry) SyncResource(input *SyncResourceInput) (*SyncResourceOutput, error) { + req, out := c.SyncResourceRequest(input) + return out, req.Send() +} + +// SyncResourceWithContext is the same as SyncResource with the addition of +// the ability to pass a context and additional request options. +// +// See SyncResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AppRegistry) SyncResourceWithContext(ctx aws.Context, input *SyncResourceInput, opts ...request.Option) (*SyncResourceOutput, error) { + req, out := c.SyncResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opTagResource = "TagResource" // TagResourceRequest generates a "aws/request.Request" representing the @@ -1595,6 +1684,8 @@ func (c *AppRegistry) TagResourceRequest(input *TagResourceInput) (req *request. // Each tag consists of a key and an optional value. If a tag with the same // key is already associated with the resource, this action updates its value. // +// This operation returns an empty response if the call was successful. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1681,6 +1772,8 @@ func (c *AppRegistry) UntagResourceRequest(input *UntagResourceInput) (req *requ // // Removes tags from a resource. // +// This operation returns an empty response if the call was successful. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3885,6 +3978,107 @@ func (s *ServiceQuotaExceededException) RequestID() string { return s.RespMetadata.RequestID } +type SyncResourceInput struct { + _ struct{} `type:"structure"` + + // An entity you can work with and specify with a name or ID. Examples include + // an Amazon EC2 instance, an AWS CloudFormation stack, or an Amazon S3 bucket. + // + // Resource is a required field + Resource *string `location:"uri" locationName:"resource" min:"1" type:"string" required:"true"` + + // The type of resource of which the application will be associated. + // + // ResourceType is a required field + ResourceType *string `location:"uri" locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"` +} + +// String returns the string representation +func (s SyncResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SyncResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SyncResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SyncResourceInput"} + if s.Resource == nil { + invalidParams.Add(request.NewErrParamRequired("Resource")) + } + if s.Resource != nil && len(*s.Resource) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Resource", 1)) + } + if s.ResourceType == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceType")) + } + if s.ResourceType != nil && len(*s.ResourceType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceType", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResource sets the Resource field's value. +func (s *SyncResourceInput) SetResource(v string) *SyncResourceInput { + s.Resource = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *SyncResourceInput) SetResourceType(v string) *SyncResourceInput { + s.ResourceType = &v + return s +} + +type SyncResourceOutput struct { + _ struct{} `type:"structure"` + + // The results of the output if an application is associated with an ARN value, + // which could be syncStarted or None. + ActionTaken *string `locationName:"actionTaken" type:"string" enum:"SyncAction"` + + // The Amazon resource name (ARN) that specifies the application. + ApplicationArn *string `locationName:"applicationArn" type:"string"` + + // The Amazon resource name (ARN) that specifies the resource. + ResourceArn *string `locationName:"resourceArn" min:"1" type:"string"` +} + +// String returns the string representation +func (s SyncResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SyncResourceOutput) GoString() string { + return s.String() +} + +// SetActionTaken sets the ActionTaken field's value. +func (s *SyncResourceOutput) SetActionTaken(v string) *SyncResourceOutput { + s.ActionTaken = &v + return s +} + +// SetApplicationArn sets the ApplicationArn field's value. +func (s *SyncResourceOutput) SetApplicationArn(v string) *SyncResourceOutput { + s.ApplicationArn = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *SyncResourceOutput) SetResourceArn(v string) *SyncResourceOutput { + s.ResourceArn = &v + return s +} + type TagResourceInput struct { _ struct{} `type:"structure"` @@ -4276,3 +4470,19 @@ func ResourceType_Values() []string { ResourceTypeCfnStack, } } + +const ( + // SyncActionStartSync is a SyncAction enum value + SyncActionStartSync = "START_SYNC" + + // SyncActionNoAction is a SyncAction enum value + SyncActionNoAction = "NO_ACTION" +) + +// SyncAction_Values returns all elements of the SyncAction enum +func SyncAction_Values() []string { + return []string{ + SyncActionStartSync, + SyncActionNoAction, + } +} diff --git a/service/appregistry/appregistryiface/interface.go b/service/appregistry/appregistryiface/interface.go index 43bb2a81508..eb23e47a04f 100644 --- a/service/appregistry/appregistryiface/interface.go +++ b/service/appregistry/appregistryiface/interface.go @@ -132,6 +132,10 @@ type AppRegistryAPI interface { ListTagsForResourceWithContext(aws.Context, *appregistry.ListTagsForResourceInput, ...request.Option) (*appregistry.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*appregistry.ListTagsForResourceInput) (*request.Request, *appregistry.ListTagsForResourceOutput) + SyncResource(*appregistry.SyncResourceInput) (*appregistry.SyncResourceOutput, error) + SyncResourceWithContext(aws.Context, *appregistry.SyncResourceInput, ...request.Option) (*appregistry.SyncResourceOutput, error) + SyncResourceRequest(*appregistry.SyncResourceInput) (*request.Request, *appregistry.SyncResourceOutput) + TagResource(*appregistry.TagResourceInput) (*appregistry.TagResourceOutput, error) TagResourceWithContext(aws.Context, *appregistry.TagResourceInput, ...request.Option) (*appregistry.TagResourceOutput, error) TagResourceRequest(*appregistry.TagResourceInput) (*request.Request, *appregistry.TagResourceOutput) diff --git a/service/batch/api.go b/service/batch/api.go index 42302898603..e19c44cf26a 100644 --- a/service/batch/api.go +++ b/service/batch/api.go @@ -74,7 +74,7 @@ func (c *Batch) CancelJobRequest(input *CancelJobInput) (req *request.Request, o // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -156,7 +156,7 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI // either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate // and Fargate Spot capacity in your managed compute environment. You can optionally // set a maximum price so that Spot Instances only launch when the Spot Instance -// price is below a specified percentage of the On-Demand price. +// price is less than a specified percentage of the On-Demand price. // // Multi-node parallel jobs are not supported on Spot Instances. // @@ -167,7 +167,7 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI // For more information, see container instance AMIs (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) // in the Amazon Elastic Container Service Developer Guide. After you have created // your unmanaged compute environment, you can use the DescribeComputeEnvironments -// operation to find the Amazon ECS cluster that is associated with it. Then, +// operation to find the Amazon ECS cluster that's associated with it. Then, // manually launch your container instances into that Amazon ECS cluster. For // more information, see Launching an Amazon ECS container instance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) // in the Amazon Elastic Container Service Developer Guide. @@ -199,7 +199,7 @@ func (c *Batch) CreateComputeEnvironmentRequest(input *CreateComputeEnvironmentI // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -291,7 +291,7 @@ func (c *Batch) CreateJobQueueRequest(input *CreateJobQueueInput) (req *request. // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -383,7 +383,7 @@ func (c *Batch) DeleteComputeEnvironmentRequest(input *DeleteComputeEnvironmentI // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -456,8 +456,9 @@ func (c *Batch) DeleteJobQueueRequest(input *DeleteJobQueueInput) (req *request. // DeleteJobQueue API operation for AWS Batch. // // Deletes the specified job queue. You must first disable submissions for a -// queue with the UpdateJobQueue operation. All jobs in the queue are terminated -// when you delete a job queue. +// queue with the UpdateJobQueue operation. All jobs in the queue are eventually +// terminated when you delete a job queue. The jobs are terminated at a rate +// of about 16 jobs each second. // // It's not necessary to disassociate compute environments from a queue before // submitting a DeleteJobQueue request. @@ -473,7 +474,7 @@ func (c *Batch) DeleteJobQueueRequest(input *DeleteJobQueueInput) (req *request. // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -559,7 +560,7 @@ func (c *Batch) DeregisterJobDefinitionRequest(input *DeregisterJobDefinitionInp // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -653,7 +654,7 @@ func (c *Batch) DescribeComputeEnvironmentsRequest(input *DescribeComputeEnviron // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -796,7 +797,7 @@ func (c *Batch) DescribeJobDefinitionsRequest(input *DescribeJobDefinitionsInput // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -938,7 +939,7 @@ func (c *Batch) DescribeJobQueuesRequest(input *DescribeJobQueuesInput) (req *re // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1074,7 +1075,7 @@ func (c *Batch) DescribeJobsRequest(input *DescribeJobsInput) (req *request.Requ // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1175,7 +1176,7 @@ func (c *Batch) ListJobsRequest(input *ListJobsInput) (req *request.Request, out // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1313,7 +1314,7 @@ func (c *Batch) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1397,7 +1398,7 @@ func (c *Batch) RegisterJobDefinitionRequest(input *RegisterJobDefinitionInput) // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1485,7 +1486,7 @@ func (c *Batch) SubmitJobRequest(input *SubmitJobInput) (req *request.Request, o // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1575,7 +1576,7 @@ func (c *Batch) TagResourceRequest(input *TagResourceInput) (req *request.Reques // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1662,7 +1663,7 @@ func (c *Batch) TerminateJobRequest(input *TerminateJobInput) (req *request.Requ // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1747,7 +1748,7 @@ func (c *Batch) UntagResourceRequest(input *UntagResourceInput) (req *request.Re // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1831,7 +1832,7 @@ func (c *Batch) UpdateComputeEnvironmentRequest(input *UpdateComputeEnvironmentI // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1915,7 +1916,7 @@ func (c *Batch) UpdateJobQueueRequest(input *UpdateJobQueueInput) (req *request. // * ClientException // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. // // * ServerException // These errors are usually caused by a server issue. @@ -1970,7 +1971,7 @@ func (s *ArrayProperties) SetSize(v int64) *ArrayProperties { type ArrayPropertiesDetail struct { _ struct{} `type:"structure"` - // The job index within the array that is associated with this job. This parameter + // The job index within the array that's associated with this job. This parameter // is returned for array job children. Index *int64 `locationName:"index" type:"integer"` @@ -2014,7 +2015,7 @@ func (s *ArrayPropertiesDetail) SetStatusSummary(v map[string]*int64) *ArrayProp type ArrayPropertiesSummary struct { _ struct{} `type:"structure"` - // The job index within the array that is associated with this job. This parameter + // The job index within the array that's associated with this job. This parameter // is returned for children of array jobs. Index *int64 `locationName:"index" type:"integer"` @@ -2044,7 +2045,7 @@ func (s *ArrayPropertiesSummary) SetSize(v int64) *ArrayPropertiesSummary { return s } -// An object representing the details of a container that is part of a job attempt. +// An object representing the details of a container that's part of a job attempt. type AttemptContainerDetail struct { _ struct{} `type:"structure"` @@ -2067,9 +2068,9 @@ type AttemptContainerDetail struct { // details about a running or stopped container. Reason *string `locationName:"reason" type:"string"` - // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated - // with the job attempt. Each container attempt receives a task ARN when they - // reach the STARTING status. + // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with + // the job attempt. Each container attempt receives a task ARN when they reach + // the STARTING status. TaskArn *string `locationName:"taskArn" type:"string"` } @@ -2174,6 +2175,7 @@ func (s *AttemptDetail) SetStoppedAt(v int64) *AttemptDetail { return s } +// Contains the parameters for CancelJob. type CancelJobInput struct { _ struct{} `type:"structure"` @@ -2244,7 +2246,7 @@ func (s CancelJobOutput) GoString() string { // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the -// action or resource, or specifying an identifier that isn't valid. +// action or resource, or specifying an identifier that's not valid. type ClientException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2309,12 +2311,15 @@ type ComputeEnvironmentDetail struct { // ComputeEnvironmentArn is a required field ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string" required:"true"` - // The name of the compute environment. + // The name of the compute environment. Up to 128 letters (uppercase and lowercase), + // numbers, hyphens, and underscores are allowed. // // ComputeEnvironmentName is a required field ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string" required:"true"` - // The compute resources defined for the compute environment. + // The compute resources defined for the compute environment. For more information, + // see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // in the AWS Batch User Guide. ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"` // The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used @@ -2324,7 +2329,9 @@ type ComputeEnvironmentDetail struct { EcsClusterArn *string `locationName:"ecsClusterArn" type:"string" required:"true"` // The service role associated with the compute environment that allows AWS - // Batch to make calls to AWS API operations on your behalf. + // Batch to make calls to AWS API operations on your behalf. For more information, + // see AWS Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) + // in the AWS Batch User Guide. ServiceRole *string `locationName:"serviceRole" type:"string"` // The state of the compute environment. The valid values are ENABLED or DISABLED. @@ -2337,7 +2344,7 @@ type ComputeEnvironmentDetail struct { // If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to // place jobs within the environment. Jobs in a STARTING or RUNNING state continue // to progress normally. Managed compute environments in the DISABLED state - // do not scale out. However, they scale in to minvCpus value after instances + // don't scale out. However, they scale in to minvCpus value after instances // become idle. State *string `locationName:"state" type:"string" enum:"CEState"` @@ -2351,8 +2358,8 @@ type ComputeEnvironmentDetail struct { // The tags applied to the compute environment. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` - // The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For - // more information, see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // The type of the compute environment: MANAGED or UNMANAGED. For more information, + // see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the AWS Batch User Guide. Type *string `locationName:"type" type:"string" enum:"CEType"` } @@ -2431,6 +2438,14 @@ func (s *ComputeEnvironmentDetail) SetType(v string) *ComputeEnvironmentDetail { // a queue. Compute environments are tried in ascending order. For example, // if two compute environments are associated with a job queue, the compute // environment with a lower order integer value is tried for job placement first. +// Compute environments must be in the VALID state before you can associate +// them with a job queue. All of the compute environments must be either EC2 +// (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute +// environments can't be mixed. +// +// All compute environments that are associated with a job queue must share +// the same architecture. AWS Batch doesn't support mixing compute environment +// architecture types in a single job queue. type ComputeEnvironmentOrder struct { _ struct{} `type:"structure"` @@ -2486,7 +2501,9 @@ func (s *ComputeEnvironmentOrder) SetOrder(v int64) *ComputeEnvironmentOrder { return s } -// An object representing an AWS Batch compute resource. +// An object representing an AWS Batch compute resource. For more information, +// see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) +// in the AWS Batch User Guide. type ComputeResource struct { _ struct{} `type:"structure"` @@ -2535,7 +2552,7 @@ type ComputeResource struct { // The maximum percentage that a Spot Instance price can be when compared with // the On-Demand price for that instance type before instances are launched. // For example, if your maximum percentage is 20%, then the Spot price must - // be below 20% of the current On-Demand price for that Amazon EC2 instance. + // be less than 20% of the current On-Demand price for that Amazon EC2 instance. // You always pay the lowest (market) price and never more than your maximum // percentage. If you leave this field empty, the default value is 100% of the // On-Demand price. @@ -2552,15 +2569,15 @@ type ComputeResource struct { // shouldn't be specified. DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"` - // Provides information used to select Amazon Machine Images (AMIs) for instances - // in the compute environment. If Ec2Configuration isn't specified, the default - // is ECS_AL1. + // Provides information used to select Amazon Machine Images (AMIs) for EC2 + // instances in the compute environment. If Ec2Configuration isn't specified, + // the default is ECS_AL1. // // This parameter isn't applicable to jobs running on Fargate resources, and // shouldn't be specified. Ec2Configuration []*Ec2Configuration `locationName:"ec2Configuration" type:"list"` - // The Amazon EC2 key pair that is used for instances launched in the compute + // The Amazon EC2 key pair that's used for instances launched in the compute // environment. You can use this key pair to log in to your instances with SSH. // // This parameter isn't applicable to jobs running on Fargate resources, and @@ -2595,11 +2612,11 @@ type ComputeResource struct { // shouldn't be specified. InstanceRole *string `locationName:"instanceRole" type:"string"` - // The instances types that may be launched. You can specify instance families + // The instances types that can be launched. You can specify instance families // to launch any instance type within those families (for example, c5 or p3), // or you can specify specific sizes within a family (such as c5.8xlarge). You - // can also choose optimal to select instance types (from the C, M, and R instance - // families) on the fly that match the demand of your job queues. + // can also choose optimal to select instance types (from the C4, M4, and R4 + // instance families) on the fly that match the demand of your job queues. // // This parameter isn't applicable to jobs running on Fargate resources, and // shouldn't be specified. @@ -2607,6 +2624,10 @@ type ComputeResource struct { // When you create a compute environment, the instance types that you select // for the compute environment must share the same architecture. For example, // you can't mix x86 and ARM instances in the same compute environment. + // + // Currently, optimal uses instance types from the C4, M4, and R4 instance families. + // In Regions that don't have instance types from those instance families, instance + // types from the C5, M5. and R5 instance families are used. InstanceTypes []*string `locationName:"instanceTypes" type:"list"` // The launch template to use for your compute resources. Any other compute @@ -2620,10 +2641,10 @@ type ComputeResource struct { // shouldn't be specified. LaunchTemplate *LaunchTemplateSpecification `locationName:"launchTemplate" type:"structure"` - // The maximum number of Amazon EC2 vCPUs that an environment can reach. + // The maximum number of Amazon EC2 vCPUs that a compute environment can reach. // // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, - // AWS Batch may need to go above maxvCpus to meet your capacity requirements. + // AWS Batch might need to go above maxvCpus to meet your capacity requirements. // In this event, AWS Batch will never go above maxvCpus by more than a single // instance (e.g., no more than a single instance from among those specified // in your compute environment). @@ -2687,19 +2708,27 @@ type ComputeResource struct { // Key-value pair tags to be applied to EC2 resources that are launched in the // compute environment. For AWS Batch, these take the form of "String1": "String2", - // where String1 is the tag key and String2 is the tag value—for example, + // where String1 is the tag key and String2 is the tag value−for example, // { "Name": "AWS Batch Instance - C4OnDemand" }. This is helpful for recognizing - // your AWS Batch instances in the Amazon EC2 console. These tags can not be - // updated or removed after the compute environment has been created; any changes - // require creating a new compute environment and removing the old compute environment. + // your AWS Batch instances in the Amazon EC2 console. These tags can't be updated + // or removed after the compute environment has been created; any changes require + // creating a new compute environment and removing the old compute environment. // These tags are not seen when using the AWS Batch ListTagsForResource API // operation. + // + // This parameter isn't applicable to jobs running on Fargate resources, and + // shouldn't be specified. Tags map[string]*string `locationName:"tags" type:"map"` // The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For // more information, see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) // in the AWS Batch User Guide. // + // If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with + // the spotIamFleetRole parameter. For more information, see Amazon EC2 Spot + // Fleet role (https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) + // in the AWS Batch User Guide. + // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"CRType"` } @@ -2846,7 +2875,8 @@ func (s *ComputeResource) SetType(v string) *ComputeResource { } // An object representing the attributes of a compute environment that can be -// updated. +// updated. For more information, see Compute Environments (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) +// in the AWS Batch User Guide. type ComputeResourceUpdate struct { _ struct{} `type:"structure"` @@ -2857,11 +2887,17 @@ type ComputeResourceUpdate struct { DesiredvCpus *int64 `locationName:"desiredvCpus" type:"integer"` // The maximum number of Amazon EC2 vCPUs that an environment can reach. + // + // With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, + // AWS Batch might need to go above maxvCpus to meet your capacity requirements. + // In this event, AWS Batch will never go above maxvCpus by more than a single + // instance (e.g., no more than a single instance from among those specified + // in your compute environment). MaxvCpus *int64 `locationName:"maxvCpus" type:"integer"` // The minimum number of Amazon EC2 vCPUs that an environment should maintain. // - // This parameter isnt applicable to jobs running on Fargate resources, and + // This parameter isn't applicable to jobs running on Fargate resources, and // shouldn't be specified. MinvCpus *int64 `locationName:"minvCpus" type:"integer"` @@ -2869,7 +2905,7 @@ type ComputeResourceUpdate struct { // compute environment. This parameter is required for Fargate compute resources, // where it can contain up to 5 security groups. This can't be specified for // EC2 compute resources. Providing an empty list is handled as if this parameter - // wasn't specified and no changeis made. + // wasn't specified and no change is made. SecurityGroupIds []*string `locationName:"securityGroupIds" type:"list"` // The VPC subnets that the compute resources are launched into. This parameter @@ -2921,11 +2957,11 @@ func (s *ComputeResourceUpdate) SetSubnets(v []*string) *ComputeResourceUpdate { return s } -// An object representing the details of a container that is part of a job. +// An object representing the details of a container that's part of a job. type ContainerDetail struct { _ struct{} `type:"structure"` - // The command that is passed to the container. + // The command that's passed to the container. Command []*string `locationName:"command" type:"list"` // The Amazon Resource Name (ARN) of the container instance that the container @@ -2983,7 +3019,8 @@ type ContainerDetail struct { // // AWS Batch currently supports a subset of the logging drivers available to // the Docker daemon (shown in the LogConfiguration data type). Additional log - // drivers may be available in future releases of the Amazon ECS container agent. + // drivers might be available in future releases of the Amazon ECS container + // agent. // // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your @@ -3046,9 +3083,9 @@ type ContainerDetail struct { // in the AWS Batch User Guide. Secrets []*Secret `locationName:"secrets" type:"list"` - // The Amazon Resource Name (ARN) of the Amazon ECS task that is associated - // with the container job. Each container attempt receives a task ARN when they - // reach the STARTING status. + // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with + // the container job. Each container attempt receives a task ARN when they reach + // the STARTING status. TaskArn *string `locationName:"taskArn" type:"string"` // A list of ulimit values to set in the container. This parameter maps to Ulimits @@ -3372,11 +3409,11 @@ func (s *ContainerOverrides) SetVcpus(v int64) *ContainerOverrides { } // Container properties are used in job definitions to describe the container -// that is launched as part of a job. +// that's launched as part of a job. type ContainerProperties struct { _ struct{} `type:"structure"` - // The command that is passed to the container. This parameter maps to Cmd in + // The command that's passed to the container. This parameter maps to Cmd in // the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) // and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/). @@ -3787,6 +3824,7 @@ func (s *ContainerSummary) SetReason(v string) *ContainerSummary { return s } +// Contains the parameters for CreateComputeEnvironment. type CreateComputeEnvironmentInput struct { _ struct{} `type:"structure"` @@ -3803,13 +3841,15 @@ type CreateComputeEnvironmentInput struct { ComputeResources *ComputeResource `locationName:"computeResources" type:"structure"` // The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch - // to make calls to other AWS services on your behalf. + // to make calls to other AWS services on your behalf. For more information, + // see AWS Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) + // 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 may contain + // 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 @@ -3821,6 +3861,17 @@ type CreateComputeEnvironmentInput struct { // The state of the compute environment. If the state is ENABLED, then the compute // environment accepts jobs from a queue and can scale out automatically based // on queues. + // + // If the state is ENABLED, then the AWS Batch scheduler can attempt to place + // jobs from an associated job queue on the compute resources within the environment. + // If the compute environment is managed, then it can scale its instances out + // or in automatically, based on the job queue demand. + // + // If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to + // place jobs within the environment. Jobs in a STARTING or RUNNING state continue + // to progress normally. Managed compute environments in the DISABLED state + // don't scale out. However, they scale in to minvCpus value after instances + // become idle. State *string `locationName:"state" type:"string" enum:"CEState"` // The tags that you apply to the compute environment to help you categorize @@ -3920,7 +3971,8 @@ type CreateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string"` - // The name of the compute environment. + // The name of the compute environment. Up to 128 letters (uppercase and lowercase), + // numbers, hyphens, and underscores are allowed. ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string"` } @@ -3946,6 +3998,7 @@ func (s *CreateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *Cr return s } +// Contains the parameters for CreateJobQueue. type CreateJobQueueInput struct { _ struct{} `type:"structure"` @@ -3957,10 +4010,15 @@ type CreateJobQueueInput struct { // must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 // and Fargate compute environments can't be mixed. // + // All compute environments that are associated with a job queue must share + // the same architecture. AWS Batch doesn't support mixing compute environment + // architecture types in a single job queue. + // // ComputeEnvironmentOrder is a required field ComputeEnvironmentOrder []*ComputeEnvironmentOrder `locationName:"computeEnvironmentOrder" type:"list" required:"true"` - // The name of the job queue. + // The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, + // and underscores are allowed. // // JobQueueName is a required field JobQueueName *string `locationName:"jobQueueName" type:"string" required:"true"` @@ -3969,7 +4027,9 @@ type CreateJobQueueInput struct { // integer value for the priority parameter) are evaluated first when associated // with the same compute environment. Priority is determined in descending order. // For example, a job queue with a priority value of 10 is given scheduling - // preference over a job queue with a priority value of 1. + // preference over a job queue with a priority value of 1. All of the compute + // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); + // EC2 and Fargate compute environments cannot be mixed. // // Priority is a required field Priority *int64 `locationName:"priority" type:"integer" required:"true"` @@ -3981,8 +4041,8 @@ type CreateJobQueueInput struct { // The tags that you apply to the job queue to help you categorize and organize // your resources. Each tag consists of a key and an optional value. For more - // information, see Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) - // in AWS General Reference. + // information, see Tagging your AWS Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) + // in AWS Batch User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` } @@ -4094,6 +4154,7 @@ func (s *CreateJobQueueOutput) SetJobQueueName(v string) *CreateJobQueueOutput { return s } +// Contains the parameters for DeleteComputeEnvironment. type DeleteComputeEnvironmentInput struct { _ struct{} `type:"structure"` @@ -4146,6 +4207,7 @@ func (s DeleteComputeEnvironmentOutput) GoString() string { return s.String() } +// Contains the parameters for DeleteJobQueue. type DeleteJobQueueInput struct { _ struct{} `type:"structure"` @@ -4251,6 +4313,7 @@ func (s DeregisterJobDefinitionOutput) GoString() string { return s.String() } +// Contains the parameters for DescribeComputeEnvironments. type DescribeComputeEnvironmentsInput struct { _ struct{} `type:"structure"` @@ -4273,7 +4336,7 @@ type DescribeComputeEnvironmentsInput struct { // returned the nextToken value. This value is null when there are no more results // to return. // - // This token should be treated as an opaque identifier that is only used to + // This token should be treated as an opaque identifier that's only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` } @@ -4341,6 +4404,7 @@ func (s *DescribeComputeEnvironmentsOutput) SetNextToken(v string) *DescribeComp return s } +// Contains the parameters for DescribeJobDefinitions. type DescribeJobDefinitionsInput struct { _ struct{} `type:"structure"` @@ -4366,7 +4430,7 @@ type DescribeJobDefinitionsInput struct { // returned the nextToken value. This value is null when there are no more results // to return. // - // This token should be treated as an opaque identifier that is only used to + // This token should be treated as an opaque identifier that's only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` @@ -4449,6 +4513,7 @@ func (s *DescribeJobDefinitionsOutput) SetNextToken(v string) *DescribeJobDefini return s } +// Contains the parameters for DescribeJobQueues. type DescribeJobQueuesInput struct { _ struct{} `type:"structure"` @@ -4471,7 +4536,7 @@ type DescribeJobQueuesInput struct { // returned the nextToken value. This value is null when there are no more results // to return. // - // This token should be treated as an opaque identifier that is only used to + // This token should be treated as an opaque identifier that's only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` } @@ -4539,6 +4604,7 @@ func (s *DescribeJobQueuesOutput) SetNextToken(v string) *DescribeJobQueuesOutpu return s } +// Contains the parameters for DescribeJobs. type DescribeJobsInput struct { _ struct{} `type:"structure"` @@ -4694,7 +4760,7 @@ type Ec2Configuration struct { // ECS_AL1 // // Amazon Linux (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami)−Default - // for all non-GPU, non-AWS-Graviton instance families. Amazon Linux is reaching + // 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 (http://aws.amazon.com/amazon-linux-ami/). // @@ -4859,7 +4925,7 @@ func (s *FargatePlatformConfiguration) SetPlatformVersion(v string) *FargatePlat type Host struct { _ struct{} `type:"structure"` - // The path on the host container instance that is presented to the container. + // The path on the host container instance that's presented to the container. // If this parameter is empty, then the Docker daemon has assigned a host path // for you. If this parameter contains a file location, then the data volume // persists at the specified location on the host container instance until you @@ -5107,7 +5173,7 @@ type JobDetail struct { // The Amazon Resource Name (ARN) of the job. JobArn *string `locationName:"jobArn" type:"string"` - // The job definition that is used by this job. + // The job definition that's used by this job. // // JobDefinition is a required field JobDefinition *string `locationName:"jobDefinition" type:"string" required:"true"` @@ -5128,7 +5194,7 @@ type JobDetail struct { // JobQueue is a required field JobQueue *string `locationName:"jobQueue" type:"string" required:"true"` - // An object representing the details of a node that is associated with a multi-node + // An object representing the details of a node that's associated with a multi-node // parallel job. NodeDetails *NodeDetails `locationName:"nodeDetails" type:"structure"` @@ -5166,7 +5232,7 @@ type JobDetail struct { // The current status for the job. // - // If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status + // If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status // (https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable) // in the troubleshooting section of the AWS Batch User Guide. // @@ -5352,7 +5418,13 @@ type JobQueueDetail struct { // JobQueueName is a required field JobQueueName *string `locationName:"jobQueueName" type:"string" required:"true"` - // The priority of the job queue. + // The priority of the job queue. Job queues with a higher priority (or a higher + // integer value for the priority parameter) are evaluated first when associated + // with the same compute environment. Priority is determined in descending order, + // for example, a job queue with a priority value of 10 is given scheduling + // preference over a job queue with a priority value of 1. All of the compute + // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); + // EC2 and Fargate compute environments cannot be mixed. // // Priority is a required field Priority *int64 `locationName:"priority" type:"integer" required:"true"` @@ -5371,7 +5443,9 @@ type JobQueueDetail struct { // status of the job queue. StatusReason *string `locationName:"statusReason" type:"string"` - // The tags applied to the job queue. + // The tags applied to the job queue. For more information, see Tagging your + // AWS Batch resources (https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html) + // in AWS Batch User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` } @@ -5440,7 +5514,7 @@ type JobSummary struct { // The array properties of the job, if it is an array job. ArrayProperties *ArrayPropertiesSummary `locationName:"arrayProperties" type:"structure"` - // An object representing the details of the container that is associated with + // An object representing the details of the container that's associated with // the job. Container *ContainerSummary `locationName:"container" type:"structure"` @@ -5726,8 +5800,27 @@ type LinuxParameters struct { // value of 100 causes pages to be swapped very aggressively. Accepted values // are whole numbers between 0 and 100. If the swappiness parameter isn't specified, // a default value of 60 is used. If a value isn't specified for maxSwap then - // this parameter is ignored. This parameter maps to the --memory-swappiness - // option to docker run (https://docs.docker.com/engine/reference/run/). + // this parameter is ignored. If maxSwap is set to 0, the container doesn't + // use swap. This parameter maps to the --memory-swappiness option to docker + // run (https://docs.docker.com/engine/reference/run/). + // + // Consider the following when you use a per-container swap configuration. + // + // * Swap space must be enabled and allocated on the container instance for + // the containers to use. The Amazon ECS optimized AMIs don't have swap enabled + // by default. You must enable swap on the instance to use this feature. + // For more information, see Instance Store Swap Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) + // in the Amazon EC2 User Guide for Linux Instances or How do I allocate + // memory to work as swap space in an Amazon EC2 instance by using a swap + // file? (http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/) + // + // * The swap space parameters are only supported for job definitions using + // EC2 resources. + // + // * If the maxSwap and swappiness parameters are omitted from a job definition, + // each container will have a default swappiness value of 60 and the total + // swap usage will be limited to two times the memory reservation of the + // container. // // This parameter isn't applicable to jobs running on Fargate resources and // shouldn't be provided. @@ -5817,6 +5910,7 @@ func (s *LinuxParameters) SetTmpfs(v []*Tmpfs) *LinuxParameters { return s } +// Contains the parameters for ListJobs. type ListJobsInput struct { _ struct{} `type:"structure"` @@ -5851,7 +5945,7 @@ type ListJobsInput struct { // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. // - // This token should be treated as an opaque identifier that is only used to + // This token should be treated as an opaque identifier that's only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` } @@ -6063,9 +6157,9 @@ type LogConfiguration struct { // and options, see Syslog logging driver (https://docs.docker.com/config/containers/logging/syslog/) // in the Docker documentation. // - // If you have a custom driver that isn't listed earlier that you want to work + // If you have a custom driver that'sn't listed earlier that you want to work // with the Amazon ECS container agent, you can fork the Amazon ECS container - // agent project that is available on GitHub (https://github.com/aws/amazon-ecs-agent) + // agent project that's available on GitHub (https://github.com/aws/amazon-ecs-agent) // and customize it to work with that driver. We encourage you to submit pull // requests for changes that you want to have included. However, Amazon Web // Services doesn't currently support running modified copies of this software. @@ -6142,8 +6236,8 @@ func (s *LogConfiguration) SetSecretOptions(v []*Secret) *LogConfiguration { return s } -// Details on a Docker volume mount point that is used in a job's container -// properties. This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) +// Details on a Docker volume mount point that's used in a job's container properties. +// This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API and the --volume option to docker run. type MountPoint struct { _ struct{} `type:"structure"` @@ -6296,7 +6390,7 @@ func (s *NodeDetails) SetNodeIndex(v int64) *NodeDetails { return s } -// Object representing any node overrides to a job definition that is used in +// Object representing any node overrides to a job definition that's used in // a SubmitJob API operation. // // This isn't applicable to jobs running on Fargate resources and shouldn't @@ -6443,7 +6537,7 @@ func (s *NodeProperties) SetNumNodes(v int64) *NodeProperties { return s } -// An object representing the properties of a node that is associated with a +// An object representing the properties of a node that's associated with a // multi-node parallel job. type NodePropertiesSummary struct { _ struct{} `type:"structure"` @@ -6489,7 +6583,7 @@ func (s *NodePropertiesSummary) SetNumNodes(v int64) *NodePropertiesSummary { return s } -// Object representing any node overrides to a job definition that is used in +// Object representing any node overrides to a job definition that's used in // a SubmitJob API operation. type NodePropertyOverride struct { _ struct{} `type:"structure"` @@ -6559,7 +6653,7 @@ type NodeRangeProperty struct { // with index values of 0 through 3. If the starting range value is omitted // (:n), then 0 is used to start the range. If the ending range value is omitted // (n:), then the highest possible node index is used to end the range. Your - // accumulative node ranges must account for all nodes (0:n). You may nest node + // accumulative node ranges must account for all nodes (0:n). You can nest node // ranges, for example 0:10 and 4:5, in which case the 4:5 range properties // override the 0:10 properties. // @@ -6607,6 +6701,7 @@ func (s *NodeRangeProperty) SetTargetNodes(v string) *NodeRangeProperty { return s } +// Contains the parameters for RegisterJobDefinition. type RegisterJobDefinitionInput struct { _ struct{} `type:"structure"` @@ -6653,7 +6748,7 @@ type RegisterJobDefinitionInput struct { PropagateTags *bool `locationName:"propagateTags" type:"boolean"` // The retry strategy to use for failed jobs that are submitted with this job - // definition. Any retry strategy that is specified during a SubmitJob operation + // definition. Any retry strategy that's specified during a SubmitJob operation // overrides the retry strategy defined here. If a job is terminated due to // a timeout, it isn't retried. RetryStrategy *RetryStrategy `locationName:"retryStrategy" type:"structure"` @@ -6667,7 +6762,7 @@ type RegisterJobDefinitionInput struct { // The timeout configuration for jobs that are submitted with this job definition, // after which AWS Batch terminates your jobs if they have not finished. If // a job is terminated due to a timeout, it isn't retried. The minimum value - // for the timeout is 60 seconds. Any timeout configuration that is specified + // for the timeout is 60 seconds. Any timeout configuration that's specified // during a SubmitJob operation overrides the timeout configuration defined // here. For more information, see Job Timeouts (https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html) // in the AWS Batch User Guide. @@ -6870,51 +6965,50 @@ type ResourceRequirement struct { // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/). - // You must specify at least 4 MiB of memory for a job. // // If you're trying to maximize your resource utilization by providing your // jobs as much memory as possible for a particular instance type, see Memory // Management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) // in the AWS Batch User Guide. // - // For jobs running on Fargate resources, then value is the hard limit (in GiB), - // represented in decimal form, and must match one of the supported values (0.5 - // and whole numbers between 1 and 30, inclusive) and the VCPU values must be - // one of the values supported for that memory value. + // For jobs running on Fargate resources, then value is the hard limit (in MiB), + // and must match one of the supported values and the VCPU values must be one + // of the values supported for that memory value. // - // value = 0.5 + // value = 512 // // VCPU = 0.25 // - // value = 1 + // value = 1024 // // VCPU = 0.25 or 0.5 // - // value = 2 + // value = 2048 // // VCPU = 0.25, 0.5, or 1 // - // value = 3 + // value = 3072 // // VCPU = 0.5, or 1 // - // value = 4 + // value = 4096 // // VCPU = 0.5, 1, or 2 // - // value = 5, 6, or 7 + // value = 5120, 6144, or 7168 // // VCPU = 1 or 2 // - // value = 8 + // value = 8192 // // VCPU = 1, 2, or 4 // - // value = 9, 10, 11, 12, 13, 14, 15, or 16 + // value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 // // VCPU = 2 or 4 // - // value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30 + // value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, + // 27648, 28672, 29696, or 30720 // // VCPU = 4 // @@ -6924,9 +7018,9 @@ type ResourceRequirement struct { // in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/). - // Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one - // vCPU. This is required but can be specified in several places; it must be - // specified for each node at least once. + // Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must + // specify at least one vCPU. This is required but can be specified in several + // places; it must be specified for each node at least once. // // For jobs running on Fargate resources, then value must match one of the supported // values and the MEMORY values must be one of the values supported for that @@ -6934,24 +7028,26 @@ type ResourceRequirement struct { // // value = 0.25 // - // MEMORY = 0.5, 1, or 2 + // MEMORY = 512, 1024, or 2048 // // value = 0.5 // - // MEMORY = 1, 2, 3, or 4 + // MEMORY = 1024, 2048, 3072, or 4096 // // value = 1 // - // MEMORY = 2, 3, 4, 5, 6, 7, or 8 + // MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192 // // value = 2 // - // MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16 + // MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, + // 14336, 15360, or 16384 // // value = 4 // - // MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, - // 25, 26, 27, 28, 29, or 30 + // MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, + // 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, + // 29696, or 30720 // // Value is a required field Value *string `locationName:"value" type:"string" required:"true"` @@ -7001,7 +7097,7 @@ func (s *ResourceRequirement) SetValue(v string) *ResourceRequirement { type RetryStrategy struct { _ struct{} `type:"structure"` - // The number of times to move a job to the RUNNABLE status. You may specify + // The number of times to move a job to the RUNNABLE status. You can specify // between 1 and 10 attempts. If the value of attempts is greater than one, // the job is retried on failure the same number of attempts as the value. Attempts *int64 `locationName:"attempts" type:"integer"` @@ -7180,6 +7276,7 @@ func (s *ServerException) RequestID() string { return s.RespMetadata.RequestID } +// Contains the parameters for SubmitJob. type SubmitJobInput struct { _ struct{} `type:"structure"` @@ -7192,7 +7289,7 @@ type SubmitJobInput struct { // A list of container overrides in JSON format that specify the name of a container // in the specified job definition and the overrides it should receive. You - // can override the default command for a container (that is specified in the + // can override the default command for a container (that's specified in the // job definition or the Docker image) with a command override. You can also // override existing environment variables (that are specified in the job definition // or Docker image) on a container or add new environment variables to it with @@ -7514,6 +7611,7 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// Contains the parameters for TerminateJob. type TerminateJobInput struct { _ struct{} `type:"structure"` @@ -7797,6 +7895,7 @@ func (s UntagResourceOutput) GoString() string { return s.String() } +// Contains the parameters for UpdateComputeEnvironment. type UpdateComputeEnvironmentInput struct { _ struct{} `type:"structure"` @@ -7807,11 +7906,15 @@ type UpdateComputeEnvironmentInput struct { ComputeEnvironment *string `locationName:"computeEnvironment" type:"string" required:"true"` // Details of the compute resources managed by the compute environment. Required - // for a managed compute environment. + // for a managed compute environment. For more information, see Compute Environments + // (https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) + // in the AWS Batch User Guide. ComputeResources *ComputeResourceUpdate `locationName:"computeResources" type:"structure"` // The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch - // to make calls to other AWS services on your behalf. + // to make calls to other AWS services on your behalf. For more information, + // see AWS Batch service IAM role (https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html) + // 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 @@ -7827,6 +7930,17 @@ type UpdateComputeEnvironmentInput struct { // The state of the compute environment. Compute environments in the ENABLED // state can accept jobs from a queue and scale in or out automatically based // on the workload demand of its associated queues. + // + // If the state is ENABLED, then the AWS Batch scheduler can attempt to place + // jobs from an associated job queue on the compute resources within the environment. + // If the compute environment is managed, then it can scale its instances out + // or in automatically, based on the job queue demand. + // + // If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to + // place jobs within the environment. Jobs in a STARTING or RUNNING state continue + // to progress normally. Managed compute environments in the DISABLED state + // don't scale out. However, they scale in to minvCpus value after instances + // become idle. State *string `locationName:"state" type:"string" enum:"CEState"` } @@ -7883,7 +7997,8 @@ type UpdateComputeEnvironmentOutput struct { // The Amazon Resource Name (ARN) of the compute environment. ComputeEnvironmentArn *string `locationName:"computeEnvironmentArn" type:"string"` - // The name of the compute environment. + // The name of the compute environment. Up to 128 letters (uppercase and lowercase), + // numbers, hyphens, and underscores are allowed. ComputeEnvironmentName *string `locationName:"computeEnvironmentName" type:"string"` } @@ -7909,14 +8024,21 @@ func (s *UpdateComputeEnvironmentOutput) SetComputeEnvironmentName(v string) *Up return s } +// Contains the parameters for UpdateJobQueue. type UpdateJobQueueInput struct { _ struct{} `type:"structure"` // Details the set of compute environments mapped to a job queue and their order // relative to each other. This is one of the parameters used by the job scheduler - // to determine which compute environment should run a given job. All of the - // compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE - // or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed. + // to determine which compute environment should run a given job. Compute environments + // must be in the VALID state before you can associate them with a job queue. + // All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate + // (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be + // mixed. + // + // All compute environments that are associated with a job queue must share + // the same architecture. AWS Batch doesn't support mixing compute environment + // architecture types in a single job queue. ComputeEnvironmentOrder []*ComputeEnvironmentOrder `locationName:"computeEnvironmentOrder" type:"list"` // The name or the Amazon Resource Name (ARN) of the job queue. @@ -7928,7 +8050,9 @@ type UpdateJobQueueInput struct { // integer value for the priority parameter) are evaluated first when associated // with the same compute environment. Priority is determined in descending order, // for example, a job queue with a priority value of 10 is given scheduling - // preference over a job queue with a priority value of 1. + // preference over a job queue with a priority value of 1. All of the compute + // environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); + // EC2 and Fargate compute environments cannot be mixed. Priority *int64 `locationName:"priority" type:"integer"` // Describes the queue's ability to accept new jobs. If the job queue state diff --git a/service/batch/errors.go b/service/batch/errors.go index 994f8361f78..e021720b629 100644 --- a/service/batch/errors.go +++ b/service/batch/errors.go @@ -13,7 +13,7 @@ const ( // // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the - // action or resource, or specifying an identifier that isn't valid. + // action or resource, or specifying an identifier that's not valid. ErrCodeClientException = "ClientException" // ErrCodeServerException for service response error code diff --git a/service/configservice/api.go b/service/configservice/api.go index a844295b837..5469e7a8e3e 100644 --- a/service/configservice/api.go +++ b/service/configservice/api.go @@ -1558,6 +1558,89 @@ func (c *ConfigService) DeleteRetentionConfigurationWithContext(ctx aws.Context, return out, req.Send() } +const opDeleteStoredQuery = "DeleteStoredQuery" + +// DeleteStoredQueryRequest generates a "aws/request.Request" representing the +// client's request for the DeleteStoredQuery operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteStoredQuery for more information on using the DeleteStoredQuery +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteStoredQueryRequest method. +// req, resp := client.DeleteStoredQueryRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DeleteStoredQuery +func (c *ConfigService) DeleteStoredQueryRequest(input *DeleteStoredQueryInput) (req *request.Request, output *DeleteStoredQueryOutput) { + op := &request.Operation{ + Name: opDeleteStoredQuery, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteStoredQueryInput{} + } + + output = &DeleteStoredQueryOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteStoredQuery API operation for AWS Config. +// +// Deletes the stored query for an AWS account in an AWS Region. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Config's +// API operation DeleteStoredQuery for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The requested action is not valid. +// +// * ResourceNotFoundException +// You have specified a resource that does not exist. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DeleteStoredQuery +func (c *ConfigService) DeleteStoredQuery(input *DeleteStoredQueryInput) (*DeleteStoredQueryOutput, error) { + req, out := c.DeleteStoredQueryRequest(input) + return out, req.Send() +} + +// DeleteStoredQueryWithContext is the same as DeleteStoredQuery with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteStoredQuery for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConfigService) DeleteStoredQueryWithContext(ctx aws.Context, input *DeleteStoredQueryInput, opts ...request.Option) (*DeleteStoredQueryOutput, error) { + req, out := c.DeleteStoredQueryRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeliverConfigSnapshot = "DeliverConfigSnapshot" // DeliverConfigSnapshotRequest generates a "aws/request.Request" representing the @@ -5350,6 +5433,88 @@ func (c *ConfigService) GetResourceConfigHistoryPagesWithContext(ctx aws.Context return p.Err() } +const opGetStoredQuery = "GetStoredQuery" + +// GetStoredQueryRequest generates a "aws/request.Request" representing the +// client's request for the GetStoredQuery operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetStoredQuery for more information on using the GetStoredQuery +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetStoredQueryRequest method. +// req, resp := client.GetStoredQueryRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/GetStoredQuery +func (c *ConfigService) GetStoredQueryRequest(input *GetStoredQueryInput) (req *request.Request, output *GetStoredQueryOutput) { + op := &request.Operation{ + Name: opGetStoredQuery, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetStoredQueryInput{} + } + + output = &GetStoredQueryOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetStoredQuery API operation for AWS Config. +// +// Returns the details of a specific stored query. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Config's +// API operation GetStoredQuery for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The requested action is not valid. +// +// * ResourceNotFoundException +// You have specified a resource that does not exist. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/GetStoredQuery +func (c *ConfigService) GetStoredQuery(input *GetStoredQueryInput) (*GetStoredQueryOutput, error) { + req, out := c.GetStoredQueryRequest(input) + return out, req.Send() +} + +// GetStoredQueryWithContext is the same as GetStoredQuery with the addition of +// the ability to pass a context and additional request options. +// +// See GetStoredQuery for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConfigService) GetStoredQueryWithContext(ctx aws.Context, input *GetStoredQueryInput, opts ...request.Option) (*GetStoredQueryOutput, error) { + req, out := c.GetStoredQueryRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListAggregateDiscoveredResources = "ListAggregateDiscoveredResources" // ListAggregateDiscoveredResourcesRequest generates a "aws/request.Request" representing the @@ -5551,6 +5716,148 @@ func (c *ConfigService) ListDiscoveredResourcesWithContext(ctx aws.Context, inpu return out, req.Send() } +const opListStoredQueries = "ListStoredQueries" + +// ListStoredQueriesRequest generates a "aws/request.Request" representing the +// client's request for the ListStoredQueries operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListStoredQueries for more information on using the ListStoredQueries +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListStoredQueriesRequest method. +// req, resp := client.ListStoredQueriesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ListStoredQueries +func (c *ConfigService) ListStoredQueriesRequest(input *ListStoredQueriesInput) (req *request.Request, output *ListStoredQueriesOutput) { + op := &request.Operation{ + Name: opListStoredQueries, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListStoredQueriesInput{} + } + + output = &ListStoredQueriesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListStoredQueries API operation for AWS Config. +// +// List the stored queries for an AWS account in an AWS Region. The default +// is 100. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Config's +// API operation ListStoredQueries for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The requested action is not valid. +// +// * InvalidNextTokenException +// The specified next token is invalid. Specify the nextToken string that was +// returned in the previous response to get the next page of results. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ListStoredQueries +func (c *ConfigService) ListStoredQueries(input *ListStoredQueriesInput) (*ListStoredQueriesOutput, error) { + req, out := c.ListStoredQueriesRequest(input) + return out, req.Send() +} + +// ListStoredQueriesWithContext is the same as ListStoredQueries with the addition of +// the ability to pass a context and additional request options. +// +// See ListStoredQueries for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConfigService) ListStoredQueriesWithContext(ctx aws.Context, input *ListStoredQueriesInput, opts ...request.Option) (*ListStoredQueriesOutput, error) { + req, out := c.ListStoredQueriesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListStoredQueriesPages iterates over the pages of a ListStoredQueries operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListStoredQueries method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListStoredQueries operation. +// pageNum := 0 +// err := client.ListStoredQueriesPages(params, +// func(page *configservice.ListStoredQueriesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ConfigService) ListStoredQueriesPages(input *ListStoredQueriesInput, fn func(*ListStoredQueriesOutput, bool) bool) error { + return c.ListStoredQueriesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListStoredQueriesPagesWithContext same as ListStoredQueriesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConfigService) ListStoredQueriesPagesWithContext(ctx aws.Context, input *ListStoredQueriesInput, fn func(*ListStoredQueriesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListStoredQueriesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListStoredQueriesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListStoredQueriesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListTagsForResource = "ListTagsForResource" // ListTagsForResourceRequest generates a "aws/request.Request" representing the @@ -7033,7 +7340,7 @@ func (c *ConfigService) PutRemediationExceptionsRequest(input *PutRemediationExc // PutRemediationExceptions API operation for AWS Config. // // A remediation exception is when a specific resource is no longer considered -// for auto-remediation. This API adds a new exception or updates an existing +// for auto-remediation. This API adds a new exception or updates an exisiting // exception for a specific resource with a specific AWS Config rule. // // AWS Config generates a remediation exception when a problem occurs executing @@ -7300,6 +7607,95 @@ func (c *ConfigService) PutRetentionConfigurationWithContext(ctx aws.Context, in return out, req.Send() } +const opPutStoredQuery = "PutStoredQuery" + +// PutStoredQueryRequest generates a "aws/request.Request" representing the +// client's request for the PutStoredQuery operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See PutStoredQuery for more information on using the PutStoredQuery +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the PutStoredQueryRequest method. +// req, resp := client.PutStoredQueryRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/PutStoredQuery +func (c *ConfigService) PutStoredQueryRequest(input *PutStoredQueryInput) (req *request.Request, output *PutStoredQueryOutput) { + op := &request.Operation{ + Name: opPutStoredQuery, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &PutStoredQueryInput{} + } + + output = &PutStoredQueryOutput{} + req = c.newRequest(op, input, output) + return +} + +// PutStoredQuery API operation for AWS Config. +// +// Saves a new query or updates an existing saved query. The QueryName must +// be unique for an AWS account in an AWS Region. You can create upto 300 queries +// in an AWS account in an AWS Region. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Config's +// API operation PutStoredQuery for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The requested action is not valid. +// +// * TooManyTagsException +// You have reached the limit of the number of tags you can use. You have more +// than 50 tags. +// +// * ResourceConcurrentModificationException +// Two users are trying to modify the same query at the same time. Wait for +// a moment and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/PutStoredQuery +func (c *ConfigService) PutStoredQuery(input *PutStoredQueryInput) (*PutStoredQueryOutput, error) { + req, out := c.PutStoredQueryRequest(input) + return out, req.Send() +} + +// PutStoredQueryWithContext is the same as PutStoredQuery with the addition of +// the ability to pass a context and additional request options. +// +// See PutStoredQuery for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConfigService) PutStoredQueryWithContext(ctx aws.Context, input *PutStoredQueryInput, opts ...request.Option) (*PutStoredQueryOutput, error) { + req, out := c.PutStoredQueryRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opSelectAggregateResourceConfig = "SelectAggregateResourceConfig" // SelectAggregateResourceConfigRequest generates a "aws/request.Request" representing the @@ -9928,7 +10324,7 @@ type ConfigurationItem struct { // The 12-digit AWS account ID associated with the resource. AccountId *string `locationName:"accountId" type:"string"` - // Amazon Resource Name (ARN) associated with the resource. + // accoun Arn *string `locationName:"arn" type:"string"` // The Availability Zone associated with the resource. @@ -10375,14 +10771,11 @@ type ConformancePackDetail struct { // AWS service that created the conformance pack. CreatedBy *string `min:"1" type:"string"` - // Amazon S3 bucket where AWS Config stores conformance pack templates. - // - // This field is optional. + // Conformance pack template that is used to create a pack. The delivery bucket + // name should start with awsconfigconforms. For example: "Resource": "arn:aws:s3:::your_bucket_name/*". DeliveryS3Bucket *string `type:"string"` // The prefix for the Amazon S3 bucket. - // - // This field is optional. DeliveryS3KeyPrefix *string `type:"string"` // Last time when conformation pack update was requested. @@ -11720,6 +12113,61 @@ func (s DeleteRetentionConfigurationOutput) GoString() string { return s.String() } +type DeleteStoredQueryInput struct { + _ struct{} `type:"structure"` + + // The name of the query that you want to delete. + // + // QueryName is a required field + QueryName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteStoredQueryInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteStoredQueryInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteStoredQueryInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteStoredQueryInput"} + if s.QueryName == nil { + invalidParams.Add(request.NewErrParamRequired("QueryName")) + } + if s.QueryName != nil && len(*s.QueryName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueryName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetQueryName sets the QueryName field's value. +func (s *DeleteStoredQueryInput) SetQueryName(v string) *DeleteStoredQueryInput { + s.QueryName = &v + return s +} + +type DeleteStoredQueryOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteStoredQueryOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteStoredQueryOutput) GoString() string { + return s.String() +} + // The input for the DeliverConfigSnapshot action. type DeliverConfigSnapshotInput struct { _ struct{} `type:"structure"` @@ -15848,19 +16296,83 @@ func (s GetResourceConfigHistoryOutput) String() string { } // GoString returns the string representation -func (s GetResourceConfigHistoryOutput) GoString() string { +func (s GetResourceConfigHistoryOutput) GoString() string { + return s.String() +} + +// SetConfigurationItems sets the ConfigurationItems field's value. +func (s *GetResourceConfigHistoryOutput) SetConfigurationItems(v []*ConfigurationItem) *GetResourceConfigHistoryOutput { + s.ConfigurationItems = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetResourceConfigHistoryOutput) SetNextToken(v string) *GetResourceConfigHistoryOutput { + s.NextToken = &v + return s +} + +type GetStoredQueryInput struct { + _ struct{} `type:"structure"` + + // The name of the query. + // + // QueryName is a required field + QueryName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetStoredQueryInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetStoredQueryInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetStoredQueryInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetStoredQueryInput"} + if s.QueryName == nil { + invalidParams.Add(request.NewErrParamRequired("QueryName")) + } + if s.QueryName != nil && len(*s.QueryName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueryName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetQueryName sets the QueryName field's value. +func (s *GetStoredQueryInput) SetQueryName(v string) *GetStoredQueryInput { + s.QueryName = &v + return s +} + +type GetStoredQueryOutput struct { + _ struct{} `type:"structure"` + + // Returns a StoredQuery object. + StoredQuery *StoredQuery `type:"structure"` +} + +// String returns the string representation +func (s GetStoredQueryOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetStoredQueryOutput) GoString() string { return s.String() } -// SetConfigurationItems sets the ConfigurationItems field's value. -func (s *GetResourceConfigHistoryOutput) SetConfigurationItems(v []*ConfigurationItem) *GetResourceConfigHistoryOutput { - s.ConfigurationItems = v - return s -} - -// SetNextToken sets the NextToken field's value. -func (s *GetResourceConfigHistoryOutput) SetNextToken(v string) *GetResourceConfigHistoryOutput { - s.NextToken = &v +// SetStoredQuery sets the StoredQuery field's value. +func (s *GetStoredQueryOutput) SetStoredQuery(v *StoredQuery) *GetStoredQueryOutput { + s.StoredQuery = v return s } @@ -16833,9 +17345,9 @@ type ListAggregateDiscoveredResourcesInput struct { // Filters the results based on the ResourceFilters object. Filters *ResourceFilters `type:"structure"` - // The maximum number of resource identifiers returned on each page. You cannot - // specify a number greater than 100. If you specify 0, AWS Config uses the - // default. + // The maximum number of resource identifiers returned on each page. The default + // is 100. You cannot specify a number greater than 100. If you specify 0, AWS + // Config uses the default. Limit *int64 `type:"integer"` // The nextToken string returned on a previous page that you use to get the @@ -17070,6 +17582,75 @@ func (s *ListDiscoveredResourcesOutput) SetResourceIdentifiers(v []*ResourceIden return s } +type ListStoredQueriesInput struct { + _ struct{} `type:"structure"` + + // The maximum number of results to be returned with a single call. + MaxResults *int64 `type:"integer"` + + // The nextToken string returned in a previous request that you use to request + // the next page of results in a paginated response. + NextToken *string `type:"string"` +} + +// String returns the string representation +func (s ListStoredQueriesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListStoredQueriesInput) GoString() string { + return s.String() +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListStoredQueriesInput) SetMaxResults(v int64) *ListStoredQueriesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStoredQueriesInput) SetNextToken(v string) *ListStoredQueriesInput { + s.NextToken = &v + return s +} + +type ListStoredQueriesOutput struct { + _ struct{} `type:"structure"` + + // If the previous paginated request didn't return all of the remaining results, + // the response object's NextToken parameter value is set to a token. To retrieve + // the next set of results, call this action again and assign that token to + // the request object's NextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `type:"string"` + + // A list of StoredQueryMetadata objects. + StoredQueryMetadata []*StoredQueryMetadata `type:"list"` +} + +// String returns the string representation +func (s ListStoredQueriesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListStoredQueriesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStoredQueriesOutput) SetNextToken(v string) *ListStoredQueriesOutput { + s.NextToken = &v + return s +} + +// SetStoredQueryMetadata sets the StoredQueryMetadata field's value. +func (s *ListStoredQueriesOutput) SetStoredQueryMetadata(v []*StoredQueryMetadata) *ListStoredQueriesOutput { + s.StoredQueryMetadata = v + return s +} + type ListTagsForResourceInput struct { _ struct{} `type:"structure"` @@ -18990,14 +19571,11 @@ type OrganizationConformancePack struct { // A list of ConformancePackInputParameter objects. ConformancePackInputParameters []*ConformancePackInputParameter `type:"list"` - // Amazon S3 bucket where AWS Config stores conformance pack templates. - // - // This field is optional. + // Location of an Amazon S3 bucket where AWS Config can deliver evaluation results + // and conformance pack template that is used to create a pack. DeliveryS3Bucket *string `type:"string"` // Any folder structure you want to add to an Amazon S3 bucket. - // - // This field is optional. DeliveryS3KeyPrefix *string `type:"string"` // A comma-separated list of accounts excluded from organization conformance @@ -20148,14 +20726,10 @@ type PutConformancePackInput struct { // ConformancePackName is a required field ConformancePackName *string `min:"1" type:"string" required:"true"` - // Amazon S3 bucket where AWS Config stores conformance pack templates. - // - // This field is optional. + // AWS Config stores intermediate files while processing conformance pack template. DeliveryS3Bucket *string `type:"string"` // The prefix for the Amazon S3 bucket. - // - // This field is optional. DeliveryS3KeyPrefix *string `type:"string"` // A string containing full conformance pack template body. Structure containing @@ -20610,14 +21184,15 @@ type PutOrganizationConformancePackInput struct { // A list of ConformancePackInputParameter objects. ConformancePackInputParameters []*ConformancePackInputParameter `type:"list"` - // Amazon S3 bucket where AWS Config stores conformance pack templates. + // Location of an Amazon S3 bucket where AWS Config can deliver evaluation results. + // AWS Config stores intermediate files while processing conformance pack template. // - // This field is optional. + // The delivery bucket name should start with awsconfigconforms. For example: + // "Resource": "arn:aws:s3:::your_bucket_name/*". For more information, see + // Permissions for cross account bucket access (https://docs.aws.amazon.com/config/latest/developerguide/conformance-pack-organization-apis.html). DeliveryS3Bucket *string `type:"string"` // The prefix for the Amazon S3 bucket. - // - // This field is optional. DeliveryS3KeyPrefix *string `type:"string"` // A list of AWS accounts to be excluded from an organization conformance pack @@ -21130,6 +21705,91 @@ func (s *PutRetentionConfigurationOutput) SetRetentionConfiguration(v *Retention return s } +type PutStoredQueryInput struct { + _ struct{} `type:"structure"` + + // A list of StoredQuery objects. The mandatory fields are QueryName and Expression. + // + // StoredQuery is a required field + StoredQuery *StoredQuery `type:"structure" required:"true"` + + // A list of Tags object. + Tags []*Tag `type:"list"` +} + +// String returns the string representation +func (s PutStoredQueryInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutStoredQueryInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutStoredQueryInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutStoredQueryInput"} + if s.StoredQuery == nil { + invalidParams.Add(request.NewErrParamRequired("StoredQuery")) + } + if s.StoredQuery != nil { + if err := s.StoredQuery.Validate(); err != nil { + invalidParams.AddNested("StoredQuery", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetStoredQuery sets the StoredQuery field's value. +func (s *PutStoredQueryInput) SetStoredQuery(v *StoredQuery) *PutStoredQueryInput { + s.StoredQuery = v + return s +} + +// SetTags sets the Tags field's value. +func (s *PutStoredQueryInput) SetTags(v []*Tag) *PutStoredQueryInput { + s.Tags = v + return s +} + +type PutStoredQueryOutput struct { + _ struct{} `type:"structure"` + + // Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id. + QueryArn *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s PutStoredQueryOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutStoredQueryOutput) GoString() string { + return s.String() +} + +// SetQueryArn sets the QueryArn field's value. +func (s *PutStoredQueryOutput) SetQueryArn(v string) *PutStoredQueryOutput { + s.QueryArn = &v + return s +} + // Details about the query. type QueryInfo struct { _ struct{} `type:"structure"` @@ -21852,6 +22512,63 @@ func (s *RemediationParameterValue) SetStaticValue(v *StaticValue) *RemediationP return s } +// Two users are trying to modify the same query at the same time. Wait for +// a moment and try again. +type ResourceConcurrentModificationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s ResourceConcurrentModificationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ResourceConcurrentModificationException) GoString() string { + return s.String() +} + +func newErrorResourceConcurrentModificationException(v protocol.ResponseMetadata) error { + return &ResourceConcurrentModificationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceConcurrentModificationException) Code() string { + return "ResourceConcurrentModificationException" +} + +// Message returns the exception's message. +func (s *ResourceConcurrentModificationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceConcurrentModificationException) OrigErr() error { + return nil +} + +func (s *ResourceConcurrentModificationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceConcurrentModificationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceConcurrentModificationException) RequestID() string { + return s.RespMetadata.RequestID +} + // An object that contains the resource type and the number of resources. type ResourceCount struct { _ struct{} `type:"structure"` @@ -23273,6 +23990,153 @@ func (s StopConfigurationRecorderOutput) GoString() string { return s.String() } +// Provides the details of a stored query. +type StoredQuery struct { + _ struct{} `type:"structure"` + + // A unique description for the query. + Description *string `type:"string"` + + // The expression of the query. For example, SELECT resourceId, resourceType, + // supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType + // = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status + // = 'Off'. + Expression *string `min:"1" type:"string"` + + // Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id. + QueryArn *string `min:"1" type:"string"` + + // The ID of the query. + QueryId *string `min:"1" type:"string"` + + // The name of the query. + // + // QueryName is a required field + QueryName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s StoredQuery) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StoredQuery) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StoredQuery) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StoredQuery"} + if s.Expression != nil && len(*s.Expression) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Expression", 1)) + } + if s.QueryArn != nil && len(*s.QueryArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueryArn", 1)) + } + if s.QueryId != nil && len(*s.QueryId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueryId", 1)) + } + if s.QueryName == nil { + invalidParams.Add(request.NewErrParamRequired("QueryName")) + } + if s.QueryName != nil && len(*s.QueryName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueryName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *StoredQuery) SetDescription(v string) *StoredQuery { + s.Description = &v + return s +} + +// SetExpression sets the Expression field's value. +func (s *StoredQuery) SetExpression(v string) *StoredQuery { + s.Expression = &v + return s +} + +// SetQueryArn sets the QueryArn field's value. +func (s *StoredQuery) SetQueryArn(v string) *StoredQuery { + s.QueryArn = &v + return s +} + +// SetQueryId sets the QueryId field's value. +func (s *StoredQuery) SetQueryId(v string) *StoredQuery { + s.QueryId = &v + return s +} + +// SetQueryName sets the QueryName field's value. +func (s *StoredQuery) SetQueryName(v string) *StoredQuery { + s.QueryName = &v + return s +} + +// Returns details of a specific query. +type StoredQueryMetadata struct { + _ struct{} `type:"structure"` + + // A unique description for the query. + Description *string `type:"string"` + + // Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id. + // + // QueryArn is a required field + QueryArn *string `min:"1" type:"string" required:"true"` + + // The ID of the query. + // + // QueryId is a required field + QueryId *string `min:"1" type:"string" required:"true"` + + // The name of the query. + // + // QueryName is a required field + QueryName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s StoredQueryMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StoredQueryMetadata) GoString() string { + return s.String() +} + +// SetDescription sets the Description field's value. +func (s *StoredQueryMetadata) SetDescription(v string) *StoredQueryMetadata { + s.Description = &v + return s +} + +// SetQueryArn sets the QueryArn field's value. +func (s *StoredQueryMetadata) SetQueryArn(v string) *StoredQueryMetadata { + s.QueryArn = &v + return s +} + +// SetQueryId sets the QueryId field's value. +func (s *StoredQueryMetadata) SetQueryId(v string) *StoredQueryMetadata { + s.QueryId = &v + return s +} + +// SetQueryName sets the QueryName field's value. +func (s *StoredQueryMetadata) SetQueryName(v string) *StoredQueryMetadata { + s.QueryName = &v + return s +} + // The tags for the resource. The metadata that you apply to a resource to help // you categorize and organize them. Each tag consists of a key and an optional // value, both of which you define. Tag keys can have a maximum character length @@ -24371,6 +25235,15 @@ const ( // ResourceTypeAwsLambdaFunction is a ResourceType enum value ResourceTypeAwsLambdaFunction = "AWS::Lambda::Function" + // ResourceTypeAwsNetworkFirewallFirewall is a ResourceType enum value + ResourceTypeAwsNetworkFirewallFirewall = "AWS::NetworkFirewall::Firewall" + + // ResourceTypeAwsNetworkFirewallFirewallPolicy is a ResourceType enum value + ResourceTypeAwsNetworkFirewallFirewallPolicy = "AWS::NetworkFirewall::FirewallPolicy" + + // ResourceTypeAwsNetworkFirewallRuleGroup is a ResourceType enum value + ResourceTypeAwsNetworkFirewallRuleGroup = "AWS::NetworkFirewall::RuleGroup" + // ResourceTypeAwsElasticBeanstalkApplication is a ResourceType enum value ResourceTypeAwsElasticBeanstalkApplication = "AWS::ElasticBeanstalk::Application" @@ -24524,6 +25397,9 @@ func ResourceType_Values() []string { ResourceTypeAwsCloudFrontDistribution, ResourceTypeAwsCloudFrontStreamingDistribution, ResourceTypeAwsLambdaFunction, + ResourceTypeAwsNetworkFirewallFirewall, + ResourceTypeAwsNetworkFirewallFirewallPolicy, + ResourceTypeAwsNetworkFirewallRuleGroup, ResourceTypeAwsElasticBeanstalkApplication, ResourceTypeAwsElasticBeanstalkApplicationVersion, ResourceTypeAwsElasticBeanstalkEnvironment, diff --git a/service/configservice/configserviceiface/interface.go b/service/configservice/configserviceiface/interface.go index dfdeeaaab7c..86aabf135ca 100644 --- a/service/configservice/configserviceiface/interface.go +++ b/service/configservice/configserviceiface/interface.go @@ -124,6 +124,10 @@ type ConfigServiceAPI interface { DeleteRetentionConfigurationWithContext(aws.Context, *configservice.DeleteRetentionConfigurationInput, ...request.Option) (*configservice.DeleteRetentionConfigurationOutput, error) DeleteRetentionConfigurationRequest(*configservice.DeleteRetentionConfigurationInput) (*request.Request, *configservice.DeleteRetentionConfigurationOutput) + DeleteStoredQuery(*configservice.DeleteStoredQueryInput) (*configservice.DeleteStoredQueryOutput, error) + DeleteStoredQueryWithContext(aws.Context, *configservice.DeleteStoredQueryInput, ...request.Option) (*configservice.DeleteStoredQueryOutput, error) + DeleteStoredQueryRequest(*configservice.DeleteStoredQueryInput) (*request.Request, *configservice.DeleteStoredQueryOutput) + DeliverConfigSnapshot(*configservice.DeliverConfigSnapshotInput) (*configservice.DeliverConfigSnapshotOutput, error) DeliverConfigSnapshotWithContext(aws.Context, *configservice.DeliverConfigSnapshotInput, ...request.Option) (*configservice.DeliverConfigSnapshotOutput, error) DeliverConfigSnapshotRequest(*configservice.DeliverConfigSnapshotInput) (*request.Request, *configservice.DeliverConfigSnapshotOutput) @@ -289,6 +293,10 @@ type ConfigServiceAPI interface { GetResourceConfigHistoryPages(*configservice.GetResourceConfigHistoryInput, func(*configservice.GetResourceConfigHistoryOutput, bool) bool) error GetResourceConfigHistoryPagesWithContext(aws.Context, *configservice.GetResourceConfigHistoryInput, func(*configservice.GetResourceConfigHistoryOutput, bool) bool, ...request.Option) error + GetStoredQuery(*configservice.GetStoredQueryInput) (*configservice.GetStoredQueryOutput, error) + GetStoredQueryWithContext(aws.Context, *configservice.GetStoredQueryInput, ...request.Option) (*configservice.GetStoredQueryOutput, error) + GetStoredQueryRequest(*configservice.GetStoredQueryInput) (*request.Request, *configservice.GetStoredQueryOutput) + ListAggregateDiscoveredResources(*configservice.ListAggregateDiscoveredResourcesInput) (*configservice.ListAggregateDiscoveredResourcesOutput, error) ListAggregateDiscoveredResourcesWithContext(aws.Context, *configservice.ListAggregateDiscoveredResourcesInput, ...request.Option) (*configservice.ListAggregateDiscoveredResourcesOutput, error) ListAggregateDiscoveredResourcesRequest(*configservice.ListAggregateDiscoveredResourcesInput) (*request.Request, *configservice.ListAggregateDiscoveredResourcesOutput) @@ -297,6 +305,13 @@ type ConfigServiceAPI interface { ListDiscoveredResourcesWithContext(aws.Context, *configservice.ListDiscoveredResourcesInput, ...request.Option) (*configservice.ListDiscoveredResourcesOutput, error) ListDiscoveredResourcesRequest(*configservice.ListDiscoveredResourcesInput) (*request.Request, *configservice.ListDiscoveredResourcesOutput) + ListStoredQueries(*configservice.ListStoredQueriesInput) (*configservice.ListStoredQueriesOutput, error) + ListStoredQueriesWithContext(aws.Context, *configservice.ListStoredQueriesInput, ...request.Option) (*configservice.ListStoredQueriesOutput, error) + ListStoredQueriesRequest(*configservice.ListStoredQueriesInput) (*request.Request, *configservice.ListStoredQueriesOutput) + + ListStoredQueriesPages(*configservice.ListStoredQueriesInput, func(*configservice.ListStoredQueriesOutput, bool) bool) error + ListStoredQueriesPagesWithContext(aws.Context, *configservice.ListStoredQueriesInput, func(*configservice.ListStoredQueriesOutput, bool) bool, ...request.Option) error + ListTagsForResource(*configservice.ListTagsForResourceInput) (*configservice.ListTagsForResourceOutput, error) ListTagsForResourceWithContext(aws.Context, *configservice.ListTagsForResourceInput, ...request.Option) (*configservice.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*configservice.ListTagsForResourceInput) (*request.Request, *configservice.ListTagsForResourceOutput) @@ -357,6 +372,10 @@ type ConfigServiceAPI interface { PutRetentionConfigurationWithContext(aws.Context, *configservice.PutRetentionConfigurationInput, ...request.Option) (*configservice.PutRetentionConfigurationOutput, error) PutRetentionConfigurationRequest(*configservice.PutRetentionConfigurationInput) (*request.Request, *configservice.PutRetentionConfigurationOutput) + PutStoredQuery(*configservice.PutStoredQueryInput) (*configservice.PutStoredQueryOutput, error) + PutStoredQueryWithContext(aws.Context, *configservice.PutStoredQueryInput, ...request.Option) (*configservice.PutStoredQueryOutput, error) + PutStoredQueryRequest(*configservice.PutStoredQueryInput) (*request.Request, *configservice.PutStoredQueryOutput) + SelectAggregateResourceConfig(*configservice.SelectAggregateResourceConfigInput) (*configservice.SelectAggregateResourceConfigOutput, error) SelectAggregateResourceConfigWithContext(aws.Context, *configservice.SelectAggregateResourceConfigInput, ...request.Option) (*configservice.SelectAggregateResourceConfigOutput, error) SelectAggregateResourceConfigRequest(*configservice.SelectAggregateResourceConfigInput) (*request.Request, *configservice.SelectAggregateResourceConfigOutput) diff --git a/service/configservice/errors.go b/service/configservice/errors.go index 2a43fb4db19..fe38206b0d5 100644 --- a/service/configservice/errors.go +++ b/service/configservice/errors.go @@ -329,6 +329,13 @@ const ( // Systems Manager or wait and try again later. ErrCodeRemediationInProgressException = "RemediationInProgressException" + // ErrCodeResourceConcurrentModificationException for service response error code + // "ResourceConcurrentModificationException". + // + // Two users are trying to modify the same query at the same time. Wait for + // a moment and try again. + ErrCodeResourceConcurrentModificationException = "ResourceConcurrentModificationException" + // ErrCodeResourceInUseException for service response error code // "ResourceInUseException". // @@ -432,6 +439,7 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "OrganizationConformancePackTemplateValidationException": newErrorOrganizationConformancePackTemplateValidationException, "OversizedConfigurationItemException": newErrorOversizedConfigurationItemException, "RemediationInProgressException": newErrorRemediationInProgressException, + "ResourceConcurrentModificationException": newErrorResourceConcurrentModificationException, "ResourceInUseException": newErrorResourceInUseException, "ResourceNotDiscoveredException": newErrorResourceNotDiscoveredException, "ResourceNotFoundException": newErrorResourceNotFoundException, diff --git a/service/connectparticipant/api.go b/service/connectparticipant/api.go index ad21a2bd5f1..329e3926131 100644 --- a/service/connectparticipant/api.go +++ b/service/connectparticipant/api.go @@ -12,6 +12,103 @@ import ( "github.com/aws/aws-sdk-go/private/protocol/restjson" ) +const opCompleteAttachmentUpload = "CompleteAttachmentUpload" + +// CompleteAttachmentUploadRequest generates a "aws/request.Request" representing the +// client's request for the CompleteAttachmentUpload operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CompleteAttachmentUpload for more information on using the CompleteAttachmentUpload +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CompleteAttachmentUploadRequest method. +// req, resp := client.CompleteAttachmentUploadRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CompleteAttachmentUpload +func (c *ConnectParticipant) CompleteAttachmentUploadRequest(input *CompleteAttachmentUploadInput) (req *request.Request, output *CompleteAttachmentUploadOutput) { + op := &request.Operation{ + Name: opCompleteAttachmentUpload, + HTTPMethod: "POST", + HTTPPath: "/participant/complete-attachment-upload", + } + + if input == nil { + input = &CompleteAttachmentUploadInput{} + } + + output = &CompleteAttachmentUploadOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// CompleteAttachmentUpload API operation for Amazon Connect Participant Service. +// +// Allows you to confirm that the attachment has been uploaded using the pre-signed +// URL provided in StartAttachmentUpload API. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Participant Service's +// API operation CompleteAttachmentUpload for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// This exception occurs when there is an internal failure in the Amazon Connect +// service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * ValidationException +// The input fails to satisfy the constraints specified by Amazon Connect. +// +// * ServiceQuotaExceededException +// The number of attachments per contact exceeds the quota. +// +// * ConflictException +// An attachment with that identifier is already being uploaded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CompleteAttachmentUpload +func (c *ConnectParticipant) CompleteAttachmentUpload(input *CompleteAttachmentUploadInput) (*CompleteAttachmentUploadOutput, error) { + req, out := c.CompleteAttachmentUploadRequest(input) + return out, req.Send() +} + +// CompleteAttachmentUploadWithContext is the same as CompleteAttachmentUpload with the addition of +// the ability to pass a context and additional request options. +// +// See CompleteAttachmentUpload for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConnectParticipant) CompleteAttachmentUploadWithContext(ctx aws.Context, input *CompleteAttachmentUploadInput, opts ...request.Option) (*CompleteAttachmentUploadOutput, error) { + req, out := c.CompleteAttachmentUploadRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateParticipantConnection = "CreateParticipantConnection" // CreateParticipantConnectionRequest generates a "aws/request.Request" representing the @@ -60,7 +157,7 @@ func (c *ConnectParticipant) CreateParticipantConnectionRequest(input *CreatePar // for invoking this API instead of ConnectionToken. // // The participant token is valid for the lifetime of the participant – until -// the they are part of a contact. +// they are part of a contact. // // The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. // Clients must manually connect to the returned websocket URL and subscribe @@ -75,6 +172,9 @@ func (c *ConnectParticipant) CreateParticipantConnectionRequest(input *CreatePar // parameter, clients need to call this API again to obtain a new websocket // URL and perform the same steps as before. // +// The Amazon Connect Participant Service APIs do not use Signature Version +// 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -166,6 +266,9 @@ func (c *ConnectParticipant) DisconnectParticipantRequest(input *DisconnectParti // Disconnects a participant. Note that ConnectionToken is used for invoking // this API instead of ParticipantToken. // +// The Amazon Connect Participant Service APIs do not use Signature Version +// 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -209,6 +312,96 @@ func (c *ConnectParticipant) DisconnectParticipantWithContext(ctx aws.Context, i return out, req.Send() } +const opGetAttachment = "GetAttachment" + +// GetAttachmentRequest generates a "aws/request.Request" representing the +// client's request for the GetAttachment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAttachment for more information on using the GetAttachment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetAttachmentRequest method. +// req, resp := client.GetAttachmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAttachment +func (c *ConnectParticipant) GetAttachmentRequest(input *GetAttachmentInput) (req *request.Request, output *GetAttachmentOutput) { + op := &request.Operation{ + Name: opGetAttachment, + HTTPMethod: "POST", + HTTPPath: "/participant/attachment", + } + + if input == nil { + input = &GetAttachmentInput{} + } + + output = &GetAttachmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAttachment API operation for Amazon Connect Participant Service. +// +// Provides a pre-signed URL for download of a completed attachment. This is +// an asynchronous API for use with active contacts. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Participant Service's +// API operation GetAttachment for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// This exception occurs when there is an internal failure in the Amazon Connect +// service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * ValidationException +// The input fails to satisfy the constraints specified by Amazon Connect. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetAttachment +func (c *ConnectParticipant) GetAttachment(input *GetAttachmentInput) (*GetAttachmentOutput, error) { + req, out := c.GetAttachmentRequest(input) + return out, req.Send() +} + +// GetAttachmentWithContext is the same as GetAttachment with the addition of +// the ability to pass a context and additional request options. +// +// See GetAttachment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConnectParticipant) GetAttachmentWithContext(ctx aws.Context, input *GetAttachmentInput, opts ...request.Option) (*GetAttachmentOutput, error) { + req, out := c.GetAttachmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetTranscript = "GetTranscript" // GetTranscriptRequest generates a "aws/request.Request" representing the @@ -259,8 +452,11 @@ func (c *ConnectParticipant) GetTranscriptRequest(input *GetTranscriptInput) (re // GetTranscript API operation for Amazon Connect Participant Service. // -// Retrieves a transcript of the session. Note that ConnectionToken is used -// for invoking this API instead of ParticipantToken. +// Retrieves a transcript of the session, including details about any attachments. +// Note that ConnectionToken is used for invoking this API instead of ParticipantToken. +// +// The Amazon Connect Participant Service APIs do not use Signature Version +// 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -404,6 +600,9 @@ func (c *ConnectParticipant) SendEventRequest(input *SendEventInput) (req *reque // Sends an event. Note that ConnectionToken is used for invoking this API instead // of ParticipantToken. // +// The Amazon Connect Participant Service APIs do not use Signature Version +// 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -494,6 +693,9 @@ func (c *ConnectParticipant) SendMessageRequest(input *SendMessageInput) (req *r // Sends a message. Note that ConnectionToken is used for invoking this API // instead of ParticipantToken. // +// The Amazon Connect Participant Service APIs do not use Signature Version +// 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -537,6 +739,99 @@ func (c *ConnectParticipant) SendMessageWithContext(ctx aws.Context, input *Send return out, req.Send() } +const opStartAttachmentUpload = "StartAttachmentUpload" + +// StartAttachmentUploadRequest generates a "aws/request.Request" representing the +// client's request for the StartAttachmentUpload operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartAttachmentUpload for more information on using the StartAttachmentUpload +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartAttachmentUploadRequest method. +// req, resp := client.StartAttachmentUploadRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/StartAttachmentUpload +func (c *ConnectParticipant) StartAttachmentUploadRequest(input *StartAttachmentUploadInput) (req *request.Request, output *StartAttachmentUploadOutput) { + op := &request.Operation{ + Name: opStartAttachmentUpload, + HTTPMethod: "POST", + HTTPPath: "/participant/start-attachment-upload", + } + + if input == nil { + input = &StartAttachmentUploadInput{} + } + + output = &StartAttachmentUploadOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartAttachmentUpload API operation for Amazon Connect Participant Service. +// +// Provides a pre-signed Amazon S3 URL in response for uploading the file directly +// to S3. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Participant Service's +// API operation StartAttachmentUpload for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// This exception occurs when there is an internal failure in the Amazon Connect +// service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * ValidationException +// The input fails to satisfy the constraints specified by Amazon Connect. +// +// * ServiceQuotaExceededException +// The number of attachments per contact exceeds the quota. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/StartAttachmentUpload +func (c *ConnectParticipant) StartAttachmentUpload(input *StartAttachmentUploadInput) (*StartAttachmentUploadOutput, error) { + req, out := c.StartAttachmentUploadRequest(input) + return out, req.Send() +} + +// StartAttachmentUploadWithContext is the same as StartAttachmentUpload with the addition of +// the ability to pass a context and additional request options. +// +// See StartAttachmentUpload for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ConnectParticipant) StartAttachmentUploadWithContext(ctx aws.Context, input *StartAttachmentUploadInput, opts ...request.Option) (*StartAttachmentUploadOutput, error) { + req, out := c.StartAttachmentUploadRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // You do not have sufficient access to perform this action. type AccessDeniedException struct { _ struct{} `type:"structure"` @@ -546,28 +841,223 @@ type AccessDeniedException struct { } // String returns the string representation -func (s AccessDeniedException) String() string { +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The case-insensitive input to indicate standard MIME type that describes +// the format of the file that will be uploaded. +type AttachmentItem struct { + _ struct{} `type:"structure"` + + // A unique identifier for the attachment. + AttachmentId *string `min:"1" type:"string"` + + // A case-sensitive name of the attachment being uploaded. + AttachmentName *string `min:"1" type:"string"` + + // Describes the MIME file type of the attachment. For a list of supported file + // types, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) + // in the Amazon Connect Administrator Guide. + ContentType *string `min:"1" type:"string"` + + // Status of the attachment. + Status *string `type:"string" enum:"ArtifactStatus"` +} + +// String returns the string representation +func (s AttachmentItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AttachmentItem) GoString() string { + return s.String() +} + +// SetAttachmentId sets the AttachmentId field's value. +func (s *AttachmentItem) SetAttachmentId(v string) *AttachmentItem { + s.AttachmentId = &v + return s +} + +// SetAttachmentName sets the AttachmentName field's value. +func (s *AttachmentItem) SetAttachmentName(v string) *AttachmentItem { + s.AttachmentName = &v + return s +} + +// SetContentType sets the ContentType field's value. +func (s *AttachmentItem) SetContentType(v string) *AttachmentItem { + s.ContentType = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AttachmentItem) SetStatus(v string) *AttachmentItem { + s.Status = &v + return s +} + +type CompleteAttachmentUploadInput struct { + _ struct{} `type:"structure"` + + // A list of unique identifiers for the attachments. + // + // AttachmentIds is a required field + AttachmentIds []*string `min:"1" type:"list" required:"true"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The authentication token associated with the participant's connection. + // + // ConnectionToken is a required field + ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CompleteAttachmentUploadInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CompleteAttachmentUploadInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CompleteAttachmentUploadInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CompleteAttachmentUploadInput"} + if s.AttachmentIds == nil { + invalidParams.Add(request.NewErrParamRequired("AttachmentIds")) + } + if s.AttachmentIds != nil && len(s.AttachmentIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttachmentIds", 1)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.ConnectionToken == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectionToken")) + } + if s.ConnectionToken != nil && len(*s.ConnectionToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectionToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttachmentIds sets the AttachmentIds field's value. +func (s *CompleteAttachmentUploadInput) SetAttachmentIds(v []*string) *CompleteAttachmentUploadInput { + s.AttachmentIds = v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CompleteAttachmentUploadInput) SetClientToken(v string) *CompleteAttachmentUploadInput { + s.ClientToken = &v + return s +} + +// SetConnectionToken sets the ConnectionToken field's value. +func (s *CompleteAttachmentUploadInput) SetConnectionToken(v string) *CompleteAttachmentUploadInput { + s.ConnectionToken = &v + return s +} + +type CompleteAttachmentUploadOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s CompleteAttachmentUploadOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CompleteAttachmentUploadOutput) GoString() string { + return s.String() +} + +// An attachment with that identifier is already being uploaded. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` +} + +// String returns the string representation +func (s ConflictException) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s AccessDeniedException) GoString() string { +func (s ConflictException) GoString() string { return s.String() } -func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { - return &AccessDeniedException{ +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ RespMetadata: v, } } // Code returns the exception type name. -func (s *AccessDeniedException) Code() string { - return "AccessDeniedException" +func (s *ConflictException) Code() string { + return "ConflictException" } // Message returns the exception's message. -func (s *AccessDeniedException) Message() string { +func (s *ConflictException) Message() string { if s.Message_ != nil { return *s.Message_ } @@ -575,21 +1065,21 @@ func (s *AccessDeniedException) Message() string { } // OrigErr always returns nil, satisfies awserr.Error interface. -func (s *AccessDeniedException) OrigErr() error { +func (s *ConflictException) OrigErr() error { return nil } -func (s *AccessDeniedException) Error() string { +func (s *ConflictException) Error() string { return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } // Status code returns the HTTP status code for the request's response error. -func (s *AccessDeniedException) StatusCode() int { +func (s *ConflictException) StatusCode() int { return s.RespMetadata.StatusCode } // RequestID returns the service's response RequestID for request. -func (s *AccessDeniedException) RequestID() string { +func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } @@ -632,7 +1122,9 @@ func (s *ConnectionCredentials) SetExpiry(v string) *ConnectionCredentials { type CreateParticipantConnectionInput struct { _ struct{} `type:"structure"` - // Participant Token as obtained from StartChatContact (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContactResponse.html) + // This is a header parameter. + // + // The Participant Token as obtained from StartChatContact (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html) // API response. // // ParticipantToken is a required field @@ -786,6 +1278,98 @@ func (s DisconnectParticipantOutput) GoString() string { return s.String() } +type GetAttachmentInput struct { + _ struct{} `type:"structure"` + + // A unique identifier for the attachment. + // + // AttachmentId is a required field + AttachmentId *string `min:"1" type:"string" required:"true"` + + // The authentication token associated with the participant's connection. + // + // ConnectionToken is a required field + ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetAttachmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAttachmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAttachmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAttachmentInput"} + if s.AttachmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AttachmentId")) + } + if s.AttachmentId != nil && len(*s.AttachmentId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttachmentId", 1)) + } + if s.ConnectionToken == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectionToken")) + } + if s.ConnectionToken != nil && len(*s.ConnectionToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectionToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttachmentId sets the AttachmentId field's value. +func (s *GetAttachmentInput) SetAttachmentId(v string) *GetAttachmentInput { + s.AttachmentId = &v + return s +} + +// SetConnectionToken sets the ConnectionToken field's value. +func (s *GetAttachmentInput) SetConnectionToken(v string) *GetAttachmentInput { + s.ConnectionToken = &v + return s +} + +type GetAttachmentOutput struct { + _ struct{} `type:"structure"` + + // The pre-signed URL using which file would be downloaded from Amazon S3 by + // the API caller. + Url *string `min:"1" type:"string"` + + // The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 + // format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + UrlExpiry *string `type:"string"` +} + +// String returns the string representation +func (s GetAttachmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAttachmentOutput) GoString() string { + return s.String() +} + +// SetUrl sets the Url field's value. +func (s *GetAttachmentOutput) SetUrl(v string) *GetAttachmentOutput { + s.Url = &v + return s +} + +// SetUrlExpiry sets the UrlExpiry field's value. +func (s *GetAttachmentOutput) SetUrlExpiry(v string) *GetAttachmentOutput { + s.UrlExpiry = &v + return s +} + type GetTranscriptInput struct { _ struct{} `type:"structure"` @@ -1003,6 +1587,9 @@ type Item struct { // 2019-11-08T02:41:28.172Z. AbsoluteTime *string `min:"1" type:"string"` + // Provides information about the attachments. + Attachments []*AttachmentItem `type:"list"` + // The content of the message or event. Content *string `min:"1" type:"string"` @@ -1041,6 +1628,12 @@ func (s *Item) SetAbsoluteTime(v string) *Item { return s } +// SetAttachments sets the Attachments field's value. +func (s *Item) SetAttachments(v []*AttachmentItem) *Item { + s.Attachments = v + return s +} + // SetContent sets the Content field's value. func (s *Item) SetContent(v string) *Item { s.Content = &v @@ -1323,6 +1916,200 @@ func (s *SendMessageOutput) SetId(v string) *SendMessageOutput { return s } +// The number of attachments per contact exceeds the quota. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +type StartAttachmentUploadInput struct { + _ struct{} `type:"structure"` + + // A case-sensitive name of the attachment being uploaded. + // + // AttachmentName is a required field + AttachmentName *string `min:"1" type:"string" required:"true"` + + // The size of the attachment in bytes. + // + // AttachmentSizeInBytes is a required field + AttachmentSizeInBytes *int64 `min:"1" type:"long" required:"true"` + + // A unique case sensitive identifier to support idempotency of request. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The authentication token associated with the participant's connection. + // + // ConnectionToken is a required field + ConnectionToken *string `location:"header" locationName:"X-Amz-Bearer" min:"1" type:"string" required:"true"` + + // Describes the MIME file type of the attachment. For a list of supported file + // types, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) + // in the Amazon Connect Administrator Guide. + // + // ContentType is a required field + ContentType *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s StartAttachmentUploadInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartAttachmentUploadInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartAttachmentUploadInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartAttachmentUploadInput"} + if s.AttachmentName == nil { + invalidParams.Add(request.NewErrParamRequired("AttachmentName")) + } + if s.AttachmentName != nil && len(*s.AttachmentName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttachmentName", 1)) + } + if s.AttachmentSizeInBytes == nil { + invalidParams.Add(request.NewErrParamRequired("AttachmentSizeInBytes")) + } + if s.AttachmentSizeInBytes != nil && *s.AttachmentSizeInBytes < 1 { + invalidParams.Add(request.NewErrParamMinValue("AttachmentSizeInBytes", 1)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.ConnectionToken == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectionToken")) + } + if s.ConnectionToken != nil && len(*s.ConnectionToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConnectionToken", 1)) + } + if s.ContentType == nil { + invalidParams.Add(request.NewErrParamRequired("ContentType")) + } + if s.ContentType != nil && len(*s.ContentType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ContentType", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttachmentName sets the AttachmentName field's value. +func (s *StartAttachmentUploadInput) SetAttachmentName(v string) *StartAttachmentUploadInput { + s.AttachmentName = &v + return s +} + +// SetAttachmentSizeInBytes sets the AttachmentSizeInBytes field's value. +func (s *StartAttachmentUploadInput) SetAttachmentSizeInBytes(v int64) *StartAttachmentUploadInput { + s.AttachmentSizeInBytes = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *StartAttachmentUploadInput) SetClientToken(v string) *StartAttachmentUploadInput { + s.ClientToken = &v + return s +} + +// SetConnectionToken sets the ConnectionToken field's value. +func (s *StartAttachmentUploadInput) SetConnectionToken(v string) *StartAttachmentUploadInput { + s.ConnectionToken = &v + return s +} + +// SetContentType sets the ContentType field's value. +func (s *StartAttachmentUploadInput) SetContentType(v string) *StartAttachmentUploadInput { + s.ContentType = &v + return s +} + +type StartAttachmentUploadOutput struct { + _ struct{} `type:"structure"` + + // A unique identifier for the attachment. + AttachmentId *string `min:"1" type:"string"` + + // Fields to be used while uploading the attachment. + UploadMetadata *UploadMetadata `type:"structure"` +} + +// String returns the string representation +func (s StartAttachmentUploadOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartAttachmentUploadOutput) GoString() string { + return s.String() +} + +// SetAttachmentId sets the AttachmentId field's value. +func (s *StartAttachmentUploadOutput) SetAttachmentId(v string) *StartAttachmentUploadOutput { + s.AttachmentId = &v + return s +} + +// SetUploadMetadata sets the UploadMetadata field's value. +func (s *StartAttachmentUploadOutput) SetUploadMetadata(v *UploadMetadata) *StartAttachmentUploadOutput { + s.UploadMetadata = v + return s +} + // A filtering option for where to start. For example, if you sent 100 messages, // start with message 50. type StartPosition struct { @@ -1441,6 +2228,50 @@ func (s *ThrottlingException) RequestID() string { return s.RespMetadata.RequestID } +// Fields to be used while uploading the attachment. +type UploadMetadata struct { + _ struct{} `type:"structure"` + + // The headers to be provided while uploading the file to the URL. + HeadersToInclude map[string]*string `type:"map"` + + // The pre-signed URL using which file would be downloaded from Amazon S3 by + // the API caller. + Url *string `min:"1" type:"string"` + + // The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 + // format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + UrlExpiry *string `type:"string"` +} + +// String returns the string representation +func (s UploadMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UploadMetadata) GoString() string { + return s.String() +} + +// SetHeadersToInclude sets the HeadersToInclude field's value. +func (s *UploadMetadata) SetHeadersToInclude(v map[string]*string) *UploadMetadata { + s.HeadersToInclude = v + return s +} + +// SetUrl sets the Url field's value. +func (s *UploadMetadata) SetUrl(v string) *UploadMetadata { + s.Url = &v + return s +} + +// SetUrlExpiry sets the UrlExpiry field's value. +func (s *UploadMetadata) SetUrlExpiry(v string) *UploadMetadata { + s.UrlExpiry = &v + return s +} + // The input fails to satisfy the constraints specified by Amazon Connect. type ValidationException struct { _ struct{} `type:"structure"` @@ -1534,12 +2365,53 @@ func (s *Websocket) SetUrl(v string) *Websocket { } const ( + // ArtifactStatusApproved is a ArtifactStatus enum value + ArtifactStatusApproved = "APPROVED" + + // ArtifactStatusRejected is a ArtifactStatus enum value + ArtifactStatusRejected = "REJECTED" + + // ArtifactStatusInProgress is a ArtifactStatus enum value + ArtifactStatusInProgress = "IN_PROGRESS" +) + +// ArtifactStatus_Values returns all elements of the ArtifactStatus enum +func ArtifactStatus_Values() []string { + return []string{ + ArtifactStatusApproved, + ArtifactStatusRejected, + ArtifactStatusInProgress, + } +} + +const ( + // ChatItemTypeTyping is a ChatItemType enum value + ChatItemTypeTyping = "TYPING" + + // ChatItemTypeParticipantJoined is a ChatItemType enum value + ChatItemTypeParticipantJoined = "PARTICIPANT_JOINED" + + // ChatItemTypeParticipantLeft is a ChatItemType enum value + ChatItemTypeParticipantLeft = "PARTICIPANT_LEFT" + + // ChatItemTypeChatEnded is a ChatItemType enum value + ChatItemTypeChatEnded = "CHAT_ENDED" + + // ChatItemTypeTransferSucceeded is a ChatItemType enum value + ChatItemTypeTransferSucceeded = "TRANSFER_SUCCEEDED" + + // ChatItemTypeTransferFailed is a ChatItemType enum value + ChatItemTypeTransferFailed = "TRANSFER_FAILED" + // ChatItemTypeMessage is a ChatItemType enum value ChatItemTypeMessage = "MESSAGE" // ChatItemTypeEvent is a ChatItemType enum value ChatItemTypeEvent = "EVENT" + // ChatItemTypeAttachment is a ChatItemType enum value + ChatItemTypeAttachment = "ATTACHMENT" + // ChatItemTypeConnectionAck is a ChatItemType enum value ChatItemTypeConnectionAck = "CONNECTION_ACK" ) @@ -1547,8 +2419,15 @@ const ( // ChatItemType_Values returns all elements of the ChatItemType enum func ChatItemType_Values() []string { return []string{ + ChatItemTypeTyping, + ChatItemTypeParticipantJoined, + ChatItemTypeParticipantLeft, + ChatItemTypeChatEnded, + ChatItemTypeTransferSucceeded, + ChatItemTypeTransferFailed, ChatItemTypeMessage, ChatItemTypeEvent, + ChatItemTypeAttachment, ChatItemTypeConnectionAck, } } diff --git a/service/connectparticipant/connectparticipantiface/interface.go b/service/connectparticipant/connectparticipantiface/interface.go index ca9b2bb7682..628ec927ef0 100644 --- a/service/connectparticipant/connectparticipantiface/interface.go +++ b/service/connectparticipant/connectparticipantiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // Amazon Connect Participant Service. // func myFunc(svc connectparticipantiface.ConnectParticipantAPI) bool { -// // Make svc.CreateParticipantConnection request +// // Make svc.CompleteAttachmentUpload request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockConnectParticipantClient struct { // connectparticipantiface.ConnectParticipantAPI // } -// func (m *mockConnectParticipantClient) CreateParticipantConnection(input *connectparticipant.CreateParticipantConnectionInput) (*connectparticipant.CreateParticipantConnectionOutput, error) { +// func (m *mockConnectParticipantClient) CompleteAttachmentUpload(input *connectparticipant.CompleteAttachmentUploadInput) (*connectparticipant.CompleteAttachmentUploadOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,10 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type ConnectParticipantAPI interface { + CompleteAttachmentUpload(*connectparticipant.CompleteAttachmentUploadInput) (*connectparticipant.CompleteAttachmentUploadOutput, error) + CompleteAttachmentUploadWithContext(aws.Context, *connectparticipant.CompleteAttachmentUploadInput, ...request.Option) (*connectparticipant.CompleteAttachmentUploadOutput, error) + CompleteAttachmentUploadRequest(*connectparticipant.CompleteAttachmentUploadInput) (*request.Request, *connectparticipant.CompleteAttachmentUploadOutput) + CreateParticipantConnection(*connectparticipant.CreateParticipantConnectionInput) (*connectparticipant.CreateParticipantConnectionOutput, error) CreateParticipantConnectionWithContext(aws.Context, *connectparticipant.CreateParticipantConnectionInput, ...request.Option) (*connectparticipant.CreateParticipantConnectionOutput, error) CreateParticipantConnectionRequest(*connectparticipant.CreateParticipantConnectionInput) (*request.Request, *connectparticipant.CreateParticipantConnectionOutput) @@ -68,6 +72,10 @@ type ConnectParticipantAPI interface { DisconnectParticipantWithContext(aws.Context, *connectparticipant.DisconnectParticipantInput, ...request.Option) (*connectparticipant.DisconnectParticipantOutput, error) DisconnectParticipantRequest(*connectparticipant.DisconnectParticipantInput) (*request.Request, *connectparticipant.DisconnectParticipantOutput) + GetAttachment(*connectparticipant.GetAttachmentInput) (*connectparticipant.GetAttachmentOutput, error) + GetAttachmentWithContext(aws.Context, *connectparticipant.GetAttachmentInput, ...request.Option) (*connectparticipant.GetAttachmentOutput, error) + GetAttachmentRequest(*connectparticipant.GetAttachmentInput) (*request.Request, *connectparticipant.GetAttachmentOutput) + GetTranscript(*connectparticipant.GetTranscriptInput) (*connectparticipant.GetTranscriptOutput, error) GetTranscriptWithContext(aws.Context, *connectparticipant.GetTranscriptInput, ...request.Option) (*connectparticipant.GetTranscriptOutput, error) GetTranscriptRequest(*connectparticipant.GetTranscriptInput) (*request.Request, *connectparticipant.GetTranscriptOutput) @@ -82,6 +90,10 @@ type ConnectParticipantAPI interface { SendMessage(*connectparticipant.SendMessageInput) (*connectparticipant.SendMessageOutput, error) SendMessageWithContext(aws.Context, *connectparticipant.SendMessageInput, ...request.Option) (*connectparticipant.SendMessageOutput, error) SendMessageRequest(*connectparticipant.SendMessageInput) (*request.Request, *connectparticipant.SendMessageOutput) + + StartAttachmentUpload(*connectparticipant.StartAttachmentUploadInput) (*connectparticipant.StartAttachmentUploadOutput, error) + StartAttachmentUploadWithContext(aws.Context, *connectparticipant.StartAttachmentUploadInput, ...request.Option) (*connectparticipant.StartAttachmentUploadOutput, error) + StartAttachmentUploadRequest(*connectparticipant.StartAttachmentUploadInput) (*request.Request, *connectparticipant.StartAttachmentUploadOutput) } var _ ConnectParticipantAPI = (*connectparticipant.ConnectParticipant)(nil) diff --git a/service/connectparticipant/errors.go b/service/connectparticipant/errors.go index 310d2d41547..a84b7d90dd0 100644 --- a/service/connectparticipant/errors.go +++ b/service/connectparticipant/errors.go @@ -14,6 +14,12 @@ const ( // You do not have sufficient access to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // An attachment with that identifier is already being uploaded. + ErrCodeConflictException = "ConflictException" + // ErrCodeInternalServerException for service response error code // "InternalServerException". // @@ -21,6 +27,12 @@ const ( // service. ErrCodeInternalServerException = "InternalServerException" + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // The number of attachments per contact exceeds the quota. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + // ErrCodeThrottlingException for service response error code // "ThrottlingException". // @@ -35,8 +47,10 @@ const ( ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ - "AccessDeniedException": newErrorAccessDeniedException, - "InternalServerException": newErrorInternalServerException, - "ThrottlingException": newErrorThrottlingException, - "ValidationException": newErrorValidationException, + "AccessDeniedException": newErrorAccessDeniedException, + "ConflictException": newErrorConflictException, + "InternalServerException": newErrorInternalServerException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ThrottlingException": newErrorThrottlingException, + "ValidationException": newErrorValidationException, } diff --git a/service/databasemigrationservice/api.go b/service/databasemigrationservice/api.go index 64c23b95a7a..f585b611f1f 100644 --- a/service/databasemigrationservice/api.go +++ b/service/databasemigrationservice/api.go @@ -10269,6 +10269,25 @@ type DocDbSettings struct { // The port value for the DocumentDB source endpoint. Port *int64 `type:"integer"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the DocumentDB endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the DocumentDB endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // The name of the server on the DocumentDB source endpoint. ServerName *string `type:"string"` @@ -10328,6 +10347,18 @@ func (s *DocDbSettings) SetPort(v int64) *DocDbSettings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *DocDbSettings) SetSecretsManagerAccessRoleArn(v string) *DocDbSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *DocDbSettings) SetSecretsManagerSecretId(v string) *DocDbSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *DocDbSettings) SetServerName(v string) *DocDbSettings { s.ServerName = &v @@ -11039,7 +11070,7 @@ func (s *EventSubscription) SetSubscriptionCreationTime(v string) *EventSubscrip // Identifies the name and value of a filter object. This filter is used to // limit the number and type of AWS DMS objects that are returned for a particular // Describe* call or similar operation. Filters are used as an optional parameter -// to the following APIs. +// for certain API operations. type Filter struct { _ struct{} `type:"structure"` @@ -11113,6 +11144,25 @@ type IBMDb2Settings struct { // Endpoint TCP port. Port *int64 `type:"integer"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the Db2 LUW endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the Db2 LUW endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // Fully qualified domain name of the endpoint. ServerName *string `type:"string"` @@ -11163,6 +11213,18 @@ func (s *IBMDb2Settings) SetPort(v int64) *IBMDb2Settings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *IBMDb2Settings) SetSecretsManagerAccessRoleArn(v string) *IBMDb2Settings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *IBMDb2Settings) SetSecretsManagerSecretId(v string) *IBMDb2Settings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *IBMDb2Settings) SetServerName(v string) *IBMDb2Settings { s.ServerName = &v @@ -12201,9 +12263,9 @@ type MicrosoftSQLServerSettings struct { // The maximum size of the packets (in bytes) used to transfer data using BCP. BcpPacketSize *int64 `type:"integer"` - // Specify a filegroup for the AWS DMS internal tables. When the replication + // Specifies a file group for the AWS DMS internal tables. When the replication // task starts, all the internal AWS DMS control tables (awsdms_ apply_exception, - // awsdms_apply, awsdms_changes) are created on the specified filegroup. + // awsdms_apply, awsdms_changes) are created for the specified file group. ControlTablesFileGroup *string `type:"string"` // Database name for the endpoint. @@ -12240,6 +12302,25 @@ type MicrosoftSQLServerSettings struct { // the same database, use the default method. SafeguardPolicy *string `type:"string" enum:"SafeguardPolicy"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the SQL Server endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the SQL Server endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // Fully qualified domain name of the endpoint. ServerName *string `type:"string"` @@ -12304,6 +12385,18 @@ func (s *MicrosoftSQLServerSettings) SetSafeguardPolicy(v string) *MicrosoftSQLS return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *MicrosoftSQLServerSettings) SetSecretsManagerAccessRoleArn(v string) *MicrosoftSQLServerSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *MicrosoftSQLServerSettings) SetSecretsManagerSecretId(v string) *MicrosoftSQLServerSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *MicrosoftSQLServerSettings) SetServerName(v string) *MicrosoftSQLServerSettings { s.ServerName = &v @@ -12860,7 +12953,7 @@ type ModifyReplicationInstanceInput struct { // A value that indicates that minor version upgrades are applied automatically // to the replication instance during the maintenance window. Changing this - // parameter doesn't result in an outage, except in the case dsecribed following. + // parameter doesn't result in an outage, except in the case described following. // The change is asynchronously applied as soon as possible. // // An outage does result if these factors apply: @@ -13348,6 +13441,25 @@ type MongoDbSettings struct { // The port value for the MongoDB source endpoint. Port *int64 `type:"integer"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the MongoDB endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the MongoDB endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // The name of the server on the MongoDB source endpoint. ServerName *string `type:"string"` @@ -13425,6 +13537,18 @@ func (s *MongoDbSettings) SetPort(v int64) *MongoDbSettings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *MongoDbSettings) SetSecretsManagerAccessRoleArn(v string) *MongoDbSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *MongoDbSettings) SetSecretsManagerSecretId(v string) *MongoDbSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *MongoDbSettings) SetServerName(v string) *MongoDbSettings { s.ServerName = &v @@ -13539,7 +13663,7 @@ type MySQLSettings struct { // Example: maxFileSize=512 MaxFileSize *int64 `type:"integer"` - // Improves performance when loading data into the MySQLcompatible target database. + // Improves performance when loading data into the MySQL-compatible target database. // Specifies how many threads to use to load the data into the MySQL-compatible // target database. Setting a large number of threads can have an adverse effect // on database performance, because a separate connection is required for each @@ -13554,6 +13678,25 @@ type MySQLSettings struct { // Endpoint TCP port. Port *int64 `type:"integer"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the MySQL endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the MySQL endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // Fully qualified domain name of the endpoint. ServerName *string `type:"string"` @@ -13626,6 +13769,18 @@ func (s *MySQLSettings) SetPort(v int64) *MySQLSettings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *MySQLSettings) SetSecretsManagerAccessRoleArn(v string) *MySQLSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *MySQLSettings) SetSecretsManagerSecretId(v string) *MySQLSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *MySQLSettings) SetServerName(v string) *MySQLSettings { s.ServerName = &v @@ -13903,6 +14058,25 @@ type OracleSettings struct { // Example: retryInterval=6; RetryInterval *int64 `type:"integer"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the Oracle endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the Oracle endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // For an Oracle source endpoint, the transparent data encryption (TDE) password // required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary // Reader. It is also the TDE_Password part of the comma-separated value you @@ -14095,6 +14269,18 @@ func (s *OracleSettings) SetRetryInterval(v int64) *OracleSettings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *OracleSettings) SetSecretsManagerAccessRoleArn(v string) *OracleSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *OracleSettings) SetSecretsManagerSecretId(v string) *OracleSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetSecurityDbEncryption sets the SecurityDbEncryption field's value. func (s *OracleSettings) SetSecurityDbEncryption(v string) *OracleSettings { s.SecurityDbEncryption = &v @@ -14374,6 +14560,25 @@ type PostgreSQLSettings struct { // Endpoint TCP port. Port *int64 `type:"integer"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the PostgreSQL endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the PostgreSQL endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // Fully qualified domain name of the endpoint. ServerName *string `type:"string"` @@ -14452,6 +14657,18 @@ func (s *PostgreSQLSettings) SetPort(v int64) *PostgreSQLSettings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *PostgreSQLSettings) SetSecretsManagerAccessRoleArn(v string) *PostgreSQLSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *PostgreSQLSettings) SetSecretsManagerSecretId(v string) *PostgreSQLSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *PostgreSQLSettings) SetServerName(v string) *PostgreSQLSettings { s.ServerName = &v @@ -14565,8 +14782,8 @@ type RedshiftSettings struct { // For full load mode, AWS DMS converts source records into .csv files and loads // them to the BucketFolder/TableID path. AWS DMS uses the Redshift COPY command // to upload the .csv files to the target table. The files are deleted once - // the COPY operation has finished. For more information, see Amazon Redshift - // Database Developer Guide (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) + // the COPY operation has finished. For more information, see COPY (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) + // in the Amazon Redshift Database Developer Guide. // // For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, and // loads the .csv files to this BucketFolder/NetChangesTableID path. @@ -14668,6 +14885,25 @@ type RedshiftSettings struct { // A list of characters that you want to replace. Use with ReplaceChars. ReplaceInvalidChars *string `type:"string"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the Amazon Redshift endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the Amazon Redshift endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // The name of the Amazon Redshift cluster you are using. ServerName *string `type:"string"` @@ -14839,6 +15075,18 @@ func (s *RedshiftSettings) SetReplaceInvalidChars(v string) *RedshiftSettings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *RedshiftSettings) SetSecretsManagerAccessRoleArn(v string) *RedshiftSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *RedshiftSettings) SetSecretsManagerSecretId(v string) *RedshiftSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *RedshiftSettings) SetServerName(v string) *RedshiftSettings { s.ServerName = &v @@ -16846,13 +17094,13 @@ type S3Settings struct { // Specifies the folder path of CDC files. For an S3 source, this setting is // required if a task captures change data; otherwise, it's optional. If CdcPath // is set, AWS DMS reads CDC files from this path and replicates the data changes - // to the target endpoint. For an S3 target, if CdcPathis set, it is the folder - // path where data changes are replicated. If you set PreserveTransactions (dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) + // to the target endpoint. For an S3 target if you set PreserveTransactions + // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) // to true, AWS DMS verifies that you have set this parameter to a folder path // on your S3 target where AWS DMS can save the transaction order for the CDC // load. AWS DMS creates this CDC folder path in either your S3 target working - // directory or the S3 target location specified by BucketFolder (dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) - // and BucketName (dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName). + // directory or the S3 target location specified by BucketFolder (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) + // and BucketName (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName). // // For example, if you specify CdcPath as MyChangedData, and you specify BucketName // as MyTargetBucket but do not specify BucketFolder, AWS DMS creates the CDC @@ -16862,6 +17110,10 @@ type S3Settings struct { // and BucketFolder as MyTargetData, AWS DMS creates the CDC folder path following: // MyTargetBucket/MyTargetData/MyChangedData. // + // For more information on CDC including transaction order on an S3 target, + // see Capturing data changes (CDC) including transaction order on the S3 target + // (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath). + // // This setting is supported in AWS DMS versions 3.4.2 and later. CdcPath *string `type:"string"` @@ -16876,7 +17128,7 @@ type S3Settings struct { CsvDelimiter *string `type:"string"` // This setting only applies if your Amazon S3 output files during a change - // data capture (CDC) load are written in .csv format. If UseCsvNoSupValue (dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) + // data capture (CDC) load are written in .csv format. If UseCsvNoSupValue (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) // is set to true, specify a string value that you want AWS DMS to use for all // columns not included in the supplemental log. If you do not specify a string // value, AWS DMS uses the null value for these columns regardless of the UseCsvNoSupValue @@ -17028,7 +17280,9 @@ type S3Settings struct { ParquetVersion *string `type:"string" enum:"ParquetVersionValue"` // If set to true, AWS DMS saves the transaction order for a change data capture - // (CDC) load on the Amazon S3 target specified by CdcPath (dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath). + // (CDC) load on the Amazon S3 target specified by CdcPath (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath). + // For more information, see Capturing data changes (CDC) including transaction + // order on the S3 target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath). // // This setting is supported in AWS DMS versions 3.4.2 and later. PreserveTransactions *bool `type:"boolean"` @@ -17082,7 +17336,7 @@ type S3Settings struct { // This setting applies if the S3 output files during a change data capture // (CDC) load are written in .csv format. If set to true for columns not included // in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue - // (dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue). + // (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue). // If not set or set to false, AWS DMS uses the null value for these columns. // // This setting is supported in AWS DMS versions 3.4.1 and later. @@ -18048,6 +18302,25 @@ type SybaseSettings struct { // Endpoint TCP port. Port *int64 `type:"integer"` + // The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS + // as the trusted entity and grants the required permissions to access the value + // in SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets + // Manager secret that allows access to the SAP ASE endpoint. + // + // You can specify one of two sets of values for these permissions. You can + // specify the values for this setting and SecretsManagerSecretId. Or you can + // specify clear-text values for UserName, Password, ServerName, and Port. You + // can't specify both. For more information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see Using secrets to access AWS Database Migration Service resources + // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) + // in the AWS Database Migration Service User Guide. + SecretsManagerAccessRoleArn *string `type:"string"` + + // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that + // contains the SAP SAE endpoint connection details. + SecretsManagerSecretId *string `type:"string"` + // Fully qualified domain name of the endpoint. ServerName *string `type:"string"` @@ -18083,6 +18356,18 @@ func (s *SybaseSettings) SetPort(v int64) *SybaseSettings { return s } +// SetSecretsManagerAccessRoleArn sets the SecretsManagerAccessRoleArn field's value. +func (s *SybaseSettings) SetSecretsManagerAccessRoleArn(v string) *SybaseSettings { + s.SecretsManagerAccessRoleArn = &v + return s +} + +// SetSecretsManagerSecretId sets the SecretsManagerSecretId field's value. +func (s *SybaseSettings) SetSecretsManagerSecretId(v string) *SybaseSettings { + s.SecretsManagerSecretId = &v + return s +} + // SetServerName sets the ServerName field's value. func (s *SybaseSettings) SetServerName(v string) *SybaseSettings { s.ServerName = &v diff --git a/service/ec2/api.go b/service/ec2/api.go index 0c0811f1987..59ea423d984 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -41478,6 +41478,9 @@ type AllocateAddressInput struct { // EC2 select an address from the address pool. To specify a specific address // from the address pool, use the Address parameter instead. PublicIpv4Pool *string `type:"string"` + + // The tags to assign to the Elastic IP address. + TagSpecifications []*TagSpecification `locationName:"TagSpecification" locationNameList:"item" type:"list"` } // String returns the string representation @@ -41526,6 +41529,12 @@ func (s *AllocateAddressInput) SetPublicIpv4Pool(v string) *AllocateAddressInput return s } +// SetTagSpecifications sets the TagSpecifications field's value. +func (s *AllocateAddressInput) SetTagSpecifications(v []*TagSpecification) *AllocateAddressInput { + s.TagSpecifications = v + return s +} + type AllocateAddressOutput struct { _ struct{} `type:"structure"` @@ -114440,17 +114449,18 @@ type TagSpecification struct { // The type of resource to tag. Currently, the resource types that support tagging // on creation are: capacity-reservation | carrier-gateway | client-vpn-endpoint - // | customer-gateway | dedicated-host | dhcp-options | export-image-task | - // export-instance-task | fleet | fpga-image | host-reservation | import-image-task - // | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 - // | key-pair | launch-template | placement-group | prefix-list | natgateway - // | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request + // | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway + // | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet + // | fpga-image | host-reservation | image| import-image-task | import-snapshot-task + // | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | + // launch-template | local-gateway-route-table-vpc-association | placement-group + // | prefix-list | natgateway | network-acl | network-interface | reserved-instances + // |route-table | security-group| snapshot | spot-fleet-request | spot-instances-request // | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target - // | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer - // | transit-gateway-multicast-domain | transit-gateway-route-table | volume - // |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) - // | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection - // | vpn-gateway. + // | transit-gateway | transit-gateway-attachment | transit-gateway-multicast-domain + // | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint + // (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) + // | vpc-flow-log | vpn-connection | vpn-gateway. // // To tag a resource after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"` diff --git a/service/glue/api.go b/service/glue/api.go index 19e1f8d4f3b..e3d1db2fd0f 100644 --- a/service/glue/api.go +++ b/service/glue/api.go @@ -19303,6 +19303,15 @@ type Connection struct { // * KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of // the CA cert file or not. AWS Glue validates for three algorithms: SHA256withRSA, // SHA384withRSA and SHA512withRSA. Default value is "false". + // + // * SECRET_ID - The secret ID used for the secret manager of credentials. + // + // * CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection. + // + // * CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection. + // + // * CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or + // CUSTOM connection. ConnectionProperties map[string]*string `type:"map"` // The type of the connection. Currently, SFTP is not supported. @@ -19416,6 +19425,14 @@ type ConnectionInput struct { // * NETWORK - Designates a network connection to a data source within an // Amazon Virtual Private Cloud environment (Amazon VPC). // + // * MARKETPLACE - Uses configuration settings contained in a connector purchased + // from AWS Marketplace to read from and write to data stores that are not + // natively supported by AWS Glue. + // + // * CUSTOM - Uses configuration settings contained in a custom connector + // to read from and write to data stores that are not natively supported + // by AWS Glue. + // // SFTP is not supported. // // ConnectionType is a required field @@ -37821,13 +37838,18 @@ func (s *SchemaColumn) SetName(v string) *SchemaColumn { return s } +// The unique ID of the schema in the AWS Glue schema registry. type SchemaId struct { _ struct{} `type:"structure"` + // The name of the schema registry that contains the schema. RegistryName *string `min:"1" type:"string"` + // The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName + // has to be provided. SchemaArn *string `min:"1" type:"string"` + // The name of the schema. One of SchemaArn or SchemaName has to be provided. SchemaName *string `min:"1" type:"string"` } @@ -38114,11 +38136,14 @@ func (s *SchemaVersionListItem) SetVersionNumber(v int64) *SchemaVersionListItem return s } +// A structure containing the schema version information. type SchemaVersionNumber struct { _ struct{} `type:"structure"` + // The latest version available for the schema. LatestVersion *bool `type:"boolean"` + // The version number of the schema. VersionNumber *int64 `min:"1" type:"long"` } @@ -44448,6 +44473,18 @@ const ( // ConnectionPropertyKeyKafkaSkipCustomCertValidation is a ConnectionPropertyKey enum value ConnectionPropertyKeyKafkaSkipCustomCertValidation = "KAFKA_SKIP_CUSTOM_CERT_VALIDATION" + + // ConnectionPropertyKeySecretId is a ConnectionPropertyKey enum value + ConnectionPropertyKeySecretId = "SECRET_ID" + + // ConnectionPropertyKeyConnectorUrl is a ConnectionPropertyKey enum value + ConnectionPropertyKeyConnectorUrl = "CONNECTOR_URL" + + // ConnectionPropertyKeyConnectorType is a ConnectionPropertyKey enum value + ConnectionPropertyKeyConnectorType = "CONNECTOR_TYPE" + + // ConnectionPropertyKeyConnectorClassName is a ConnectionPropertyKey enum value + ConnectionPropertyKeyConnectorClassName = "CONNECTOR_CLASS_NAME" ) // ConnectionPropertyKey_Values returns all elements of the ConnectionPropertyKey enum @@ -44474,6 +44511,10 @@ func ConnectionPropertyKey_Values() []string { ConnectionPropertyKeyKafkaSslEnabled, ConnectionPropertyKeyKafkaCustomCert, ConnectionPropertyKeyKafkaSkipCustomCertValidation, + ConnectionPropertyKeySecretId, + ConnectionPropertyKeyConnectorUrl, + ConnectionPropertyKeyConnectorType, + ConnectionPropertyKeyConnectorClassName, } } @@ -44492,6 +44533,12 @@ const ( // ConnectionTypeNetwork is a ConnectionType enum value ConnectionTypeNetwork = "NETWORK" + + // ConnectionTypeMarketplace is a ConnectionType enum value + ConnectionTypeMarketplace = "MARKETPLACE" + + // ConnectionTypeCustom is a ConnectionType enum value + ConnectionTypeCustom = "CUSTOM" ) // ConnectionType_Values returns all elements of the ConnectionType enum @@ -44502,6 +44549,8 @@ func ConnectionType_Values() []string { ConnectionTypeMongodb, ConnectionTypeKafka, ConnectionTypeNetwork, + ConnectionTypeMarketplace, + ConnectionTypeCustom, } } diff --git a/service/managedblockchain/api.go b/service/managedblockchain/api.go index 7d9ad2f45a9..0b06dc9bbe9 100644 --- a/service/managedblockchain/api.go +++ b/service/managedblockchain/api.go @@ -59,6 +59,8 @@ func (c *ManagedBlockchain) CreateMemberRequest(input *CreateMemberInput) (req * // // Creates a member within a Managed Blockchain network. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -168,6 +170,8 @@ func (c *ManagedBlockchain) CreateNetworkRequest(input *CreateNetworkInput) (req // // Creates a new blockchain network using Amazon Managed Blockchain. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -253,7 +257,7 @@ func (c *ManagedBlockchain) CreateNodeRequest(input *CreateNodeInput) (req *requ op := &request.Operation{ Name: opCreateNode, HTTPMethod: "POST", - HTTPPath: "/networks/{networkId}/members/{memberId}/nodes", + HTTPPath: "/networks/{networkId}/nodes", } if input == nil { @@ -267,7 +271,9 @@ func (c *ManagedBlockchain) CreateNodeRequest(input *CreateNodeInput) (req *requ // CreateNode API operation for Amazon Managed Blockchain. // -// Creates a peer node in a member. +// Creates a node on the specified blockchain network. +// +// Applies to Hyperledger Fabric and Ethereum. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -380,6 +386,8 @@ func (c *ManagedBlockchain) CreateProposalRequest(input *CreateProposalInput) (r // network can vote on, for example, a proposal to add a new member to the network. // Any member can create a proposal. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -488,6 +496,8 @@ func (c *ManagedBlockchain) DeleteMemberRequest(input *DeleteMemberInput) (req * // If MemberId is the last member in a network specified by the last AWS account, // the network is deleted also. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -573,7 +583,7 @@ func (c *ManagedBlockchain) DeleteNodeRequest(input *DeleteNodeInput) (req *requ op := &request.Operation{ Name: opDeleteNode, HTTPMethod: "DELETE", - HTTPPath: "/networks/{networkId}/members/{memberId}/nodes/{nodeId}", + HTTPPath: "/networks/{networkId}/nodes/{nodeId}", } if input == nil { @@ -588,8 +598,10 @@ func (c *ManagedBlockchain) DeleteNodeRequest(input *DeleteNodeInput) (req *requ // DeleteNode API operation for Amazon Managed Blockchain. // -// Deletes a peer node from a member that your AWS account owns. All data on -// the node is lost and cannot be recovered. +// Deletes a node that your AWS account owns. All data on the node is lost and +// cannot be recovered. +// +// Applies to Hyperledger Fabric and Ethereum. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -692,6 +704,8 @@ func (c *ManagedBlockchain) GetMemberRequest(input *GetMemberInput) (req *reques // // Returns detailed information about a member. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -789,6 +803,8 @@ func (c *ManagedBlockchain) GetNetworkRequest(input *GetNetworkInput) (req *requ // // Returns detailed information about a network. // +// Applies to Hyperledger Fabric and Ethereum. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -870,7 +886,7 @@ func (c *ManagedBlockchain) GetNodeRequest(input *GetNodeInput) (req *request.Re op := &request.Operation{ Name: opGetNode, HTTPMethod: "GET", - HTTPPath: "/networks/{networkId}/members/{memberId}/nodes/{nodeId}", + HTTPPath: "/networks/{networkId}/nodes/{nodeId}", } if input == nil { @@ -884,7 +900,9 @@ func (c *ManagedBlockchain) GetNodeRequest(input *GetNodeInput) (req *request.Re // GetNode API operation for Amazon Managed Blockchain. // -// Returns detailed information about a peer node. +// Returns detailed information about a node. +// +// Applies to Hyperledger Fabric and Ethereum. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -983,6 +1001,8 @@ func (c *ManagedBlockchain) GetProposalRequest(input *GetProposalInput) (req *re // // Returns detailed information about a proposal. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1084,7 +1104,9 @@ func (c *ManagedBlockchain) ListInvitationsRequest(input *ListInvitationsInput) // ListInvitations API operation for Amazon Managed Blockchain. // -// Returns a listing of all invitations for the current AWS account. +// Returns a list of all invitations for the current AWS account. +// +// Applies only to Hyperledger Fabric. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1244,7 +1266,9 @@ func (c *ManagedBlockchain) ListMembersRequest(input *ListMembersInput) (req *re // ListMembers API operation for Amazon Managed Blockchain. // -// Returns a listing of the members in a network and properties of their configurations. +// Returns a list of the members in a network and properties of their configurations. +// +// Applies only to Hyperledger Fabric. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1395,8 +1419,9 @@ func (c *ManagedBlockchain) ListNetworksRequest(input *ListNetworksInput) (req * // ListNetworks API operation for Amazon Managed Blockchain. // -// Returns information about the networks in which the current AWS account has -// members. +// Returns information about the networks in which the current AWS account participates. +// +// Applies to Hyperledger Fabric and Ethereum. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1527,7 +1552,7 @@ func (c *ManagedBlockchain) ListNodesRequest(input *ListNodesInput) (req *reques op := &request.Operation{ Name: opListNodes, HTTPMethod: "GET", - HTTPPath: "/networks/{networkId}/members/{memberId}/nodes", + HTTPPath: "/networks/{networkId}/nodes", Paginator: &request.Paginator{ InputTokens: []string{"NextToken"}, OutputTokens: []string{"NextToken"}, @@ -1549,6 +1574,8 @@ func (c *ManagedBlockchain) ListNodesRequest(input *ListNodesInput) (req *reques // // Returns information about the nodes within a network. // +// Applies to Hyperledger Fabric and Ethereum. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1698,8 +1725,10 @@ func (c *ManagedBlockchain) ListProposalVotesRequest(input *ListProposalVotesInp // ListProposalVotes API operation for Amazon Managed Blockchain. // -// Returns the listing of votes for a specified proposal, including the value -// of each vote and the unique identifier of the member that cast the vote. +// Returns the list of votes for a specified proposal, including the value of +// each vote and the unique identifier of the member that cast the vote. +// +// Applies only to Hyperledger Fabric. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1850,7 +1879,9 @@ func (c *ManagedBlockchain) ListProposalsRequest(input *ListProposalsInput) (req // ListProposals API operation for Amazon Managed Blockchain. // -// Returns a listing of proposals for the network. +// Returns a list of proposals for the network. +// +// Applies only to Hyperledger Fabric. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2004,6 +2035,8 @@ func (c *ManagedBlockchain) RejectInvitationRequest(input *RejectInvitationInput // in an AWS account that has received an invitation to create a member and // join a network. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2104,6 +2137,8 @@ func (c *ManagedBlockchain) UpdateMemberRequest(input *UpdateMemberInput) (req * // // Updates a member configuration with new parameters. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2185,7 +2220,7 @@ func (c *ManagedBlockchain) UpdateNodeRequest(input *UpdateNodeInput) (req *requ op := &request.Operation{ Name: opUpdateNode, HTTPMethod: "PATCH", - HTTPPath: "/networks/{networkId}/members/{memberId}/nodes/{nodeId}", + HTTPPath: "/networks/{networkId}/nodes/{nodeId}", } if input == nil { @@ -2202,6 +2237,8 @@ func (c *ManagedBlockchain) UpdateNodeRequest(input *UpdateNodeInput) (req *requ // // Updates a node configuration with new parameters. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2302,6 +2339,8 @@ func (c *ManagedBlockchain) VoteOnProposalRequest(input *VoteOnProposalInput) (r // to vote as, specified by VoterMemberId, must be in the same AWS account as // the principal that calls the action. // +// Applies only to Hyperledger Fabric. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2360,7 +2399,7 @@ type AccessDeniedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - Message_ *string `locationName:"message" type:"string"` + Message_ *string `locationName:"Message" type:"string"` } // String returns the string representation @@ -2415,6 +2454,8 @@ func (s *AccessDeniedException) RequestID() string { // if a proposal is approved. Approval may be based on criteria such as the // percentage of YES votes and the duration of the proposal. The policy applies // to all proposals and is specified when the network is created. +// +// Applies only to Hyperledger Fabric. type ApprovalThresholdPolicy struct { _ struct{} `type:"structure"` @@ -2789,10 +2830,18 @@ type CreateNodeInput struct { // The unique identifier of the member that owns this node. // - // MemberId is a required field - MemberId *string `location:"uri" locationName:"memberId" min:"1" type:"string" required:"true"` + // Applies only to Hyperledger Fabric. + MemberId *string `min:"1" type:"string"` - // The unique identifier of the network in which this node runs. + // The unique identifier of the network for the node. + // + // Ethereum public networks have the following NetworkIds: + // + // * n-ethereum-mainnet + // + // * n-ethereum-rinkeby + // + // * n-ethereum-ropsten // // NetworkId is a required field NetworkId *string `location:"uri" locationName:"networkId" min:"1" type:"string" required:"true"` @@ -2819,9 +2868,6 @@ func (s *CreateNodeInput) Validate() error { if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.MemberId == nil { - invalidParams.Add(request.NewErrParamRequired("MemberId")) - } if s.MemberId != nil && len(*s.MemberId) < 1 { invalidParams.Add(request.NewErrParamMinLen("MemberId", 1)) } @@ -3100,10 +3146,18 @@ type DeleteNodeInput struct { // The unique identifier of the member that owns this node. // - // MemberId is a required field - MemberId *string `location:"uri" locationName:"memberId" min:"1" type:"string" required:"true"` + // Applies only to Hyperledger Fabric and is required for Hyperledger Fabric. + MemberId *string `location:"querystring" locationName:"memberId" min:"1" type:"string"` - // The unique identifier of the network that the node belongs to. + // The unique identifier of the network that the node is on. + // + // Ethereum public networks have the following NetworkIds: + // + // * n-ethereum-mainnet + // + // * n-ethereum-rinkeby + // + // * n-ethereum-ropsten // // NetworkId is a required field NetworkId *string `location:"uri" locationName:"networkId" min:"1" type:"string" required:"true"` @@ -3127,9 +3181,6 @@ func (s DeleteNodeInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DeleteNodeInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DeleteNodeInput"} - if s.MemberId == nil { - invalidParams.Add(request.NewErrParamRequired("MemberId")) - } if s.MemberId != nil && len(*s.MemberId) < 1 { invalidParams.Add(request.NewErrParamMinLen("MemberId", 1)) } @@ -3334,10 +3385,10 @@ type GetNodeInput struct { // The unique identifier of the member that owns the node. // - // MemberId is a required field - MemberId *string `location:"uri" locationName:"memberId" min:"1" type:"string" required:"true"` + // Applies only to Hyperledger Fabric and is required for Hyperledger Fabric. + MemberId *string `location:"querystring" locationName:"memberId" min:"1" type:"string"` - // The unique identifier of the network to which the node belongs. + // The unique identifier of the network that the node is on. // // NetworkId is a required field NetworkId *string `location:"uri" locationName:"networkId" min:"1" type:"string" required:"true"` @@ -3361,9 +3412,6 @@ func (s GetNodeInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *GetNodeInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "GetNodeInput"} - if s.MemberId == nil { - invalidParams.Add(request.NewErrParamRequired("MemberId")) - } if s.MemberId != nil && len(*s.MemberId) < 1 { invalidParams.Add(request.NewErrParamMinLen("MemberId", 1)) } @@ -3678,6 +3726,8 @@ func (s *InvalidRequestException) RequestID() string { } // An invitation to an AWS account to create a member and join the network. +// +// Applies only to Hyperledger Fabric. type Invitation struct { _ struct{} `type:"structure"` @@ -3756,6 +3806,8 @@ func (s *Invitation) SetStatus(v string) *Invitation { // An action to invite a specific AWS account to create a member and join the // network. The InviteAction is carried out when a Proposal is APPROVED. +// +// Applies only to Hyperledger Fabric. type InviteAction struct { _ struct{} `type:"structure"` @@ -4014,6 +4066,8 @@ type ListNetworksInput struct { // An optional status specifier. If provided, only networks currently in this // status are listed. + // + // Applies only to Hyperledger Fabric. Status *string `location:"querystring" locationName:"status" type:"string" enum:"NetworkStatus"` } @@ -4111,8 +4165,8 @@ type ListNodesInput struct { // The unique identifier of the member who owns the nodes to list. // - // MemberId is a required field - MemberId *string `location:"uri" locationName:"memberId" min:"1" type:"string" required:"true"` + // Applies only to Hyperledger Fabric and is required for Hyperledger Fabric. + MemberId *string `location:"querystring" locationName:"memberId" min:"1" type:"string"` // The unique identifier of the network for which to list nodes. // @@ -4143,9 +4197,6 @@ func (s *ListNodesInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.MemberId == nil { - invalidParams.Add(request.NewErrParamRequired("MemberId")) - } if s.MemberId != nil && len(*s.MemberId) < 1 { invalidParams.Add(request.NewErrParamMinLen("MemberId", 1)) } @@ -4310,7 +4361,7 @@ type ListProposalVotesOutput struct { // The pagination token that indicates the next set of results to retrieve. NextToken *string `type:"string"` - // The listing of votes. + // The list of votes. ProposalVotes []*VoteSummary `type:"list"` } @@ -4479,6 +4530,8 @@ func (s *LogConfigurations) SetCloudwatch(v *LogConfiguration) *LogConfiguration } // Member configuration properties. +// +// Applies only to Hyperledger Fabric. type Member struct { _ struct{} `type:"structure"` @@ -4584,6 +4637,8 @@ func (s *Member) SetStatus(v string) *Member { } // Configuration properties of the member. +// +// Applies only to Hyperledger Fabric. type MemberConfiguration struct { _ struct{} `type:"structure"` @@ -4705,8 +4760,8 @@ type MemberFabricConfiguration struct { // The password for the member's initial administrative user. The AdminPassword // must be at least eight characters long and no more than 32 characters. It // must contain at least one uppercase letter, one lowercase letter, and one - // digit. It cannot have a single quote(‘), double quote(“), forward slash(/), - // backward slash(\), @, or a space. + // digit. It cannot have a single quotation mark (‘), a double quotation marks + // (“), a forward slash(/), a backward slash(\), @, or a space. // // AdminPassword is a required field AdminPassword *string `min:"8" type:"string" required:"true" sensitive:"true"` @@ -4882,6 +4937,8 @@ func (s *MemberLogPublishingConfiguration) SetFabric(v *MemberFabricLogPublishin } // A summary of configuration properties for a member. +// +// Applies only to Hyperledger Fabric. type MemberSummary struct { _ struct{} `type:"structure"` @@ -5075,6 +5132,37 @@ func (s *Network) SetVpcEndpointServiceName(v string) *Network { return s } +// Attributes of Ethereum for a network. +type NetworkEthereumAttributes struct { + _ struct{} `type:"structure"` + + // The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are + // as follows: + // + // * mainnet = 1 + // + // * rinkeby = 4 + // + // * ropsten = 3 + ChainId *string `type:"string"` +} + +// String returns the string representation +func (s NetworkEthereumAttributes) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s NetworkEthereumAttributes) GoString() string { + return s.String() +} + +// SetChainId sets the ChainId field's value. +func (s *NetworkEthereumAttributes) SetChainId(v string) *NetworkEthereumAttributes { + s.ChainId = &v + return s +} + // Attributes of Hyperledger Fabric for a network. type NetworkFabricAttributes struct { _ struct{} `type:"structure"` @@ -5154,6 +5242,10 @@ func (s *NetworkFabricConfiguration) SetEdition(v string) *NetworkFabricConfigur type NetworkFrameworkAttributes struct { _ struct{} `type:"structure"` + // Attributes of an Ethereum network for Managed Blockchain resources participating + // in an Ethereum network. + Ethereum *NetworkEthereumAttributes `type:"structure"` + // Attributes of Hyperledger Fabric for a Managed Blockchain network that uses // Hyperledger Fabric. Fabric *NetworkFabricAttributes `type:"structure"` @@ -5169,6 +5261,12 @@ func (s NetworkFrameworkAttributes) GoString() string { return s.String() } +// SetEthereum sets the Ethereum field's value. +func (s *NetworkFrameworkAttributes) SetEthereum(v *NetworkEthereumAttributes) *NetworkFrameworkAttributes { + s.Ethereum = v + return s +} + // SetFabric sets the Fabric field's value. func (s *NetworkFrameworkAttributes) SetFabric(v *NetworkFabricAttributes) *NetworkFrameworkAttributes { s.Fabric = v @@ -5294,7 +5392,7 @@ func (s *NetworkSummary) SetStatus(v string) *NetworkSummary { return s } -// Configuration properties of a peer node. +// Configuration properties of a node. type Node struct { _ struct{} `type:"structure"` @@ -5313,17 +5411,21 @@ type Node struct { // The instance type of the node. InstanceType *string `type:"string"` - // Configuration properties for logging events associated with a peer node owned - // by a member in a Managed Blockchain network. + // Configuration properties for logging events associated with a peer node on + // a Hyperledger Fabric network on Managed Blockchain. LogPublishingConfiguration *NodeLogPublishingConfiguration `type:"structure"` // The unique identifier of the member to which the node belongs. + // + // Applies only to Hyperledger Fabric. MemberId *string `min:"1" type:"string"` - // The unique identifier of the network that the node is in. + // The unique identifier of the network that the node is on. NetworkId *string `min:"1" type:"string"` // The state database that the node uses. Values are LevelDB or CouchDB. + // + // Applies only to Hyperledger Fabric. StateDB *string `type:"string" enum:"StateDBType"` // The status of the node. @@ -5400,27 +5502,27 @@ func (s *Node) SetStatus(v string) *Node { return s } -// Configuration properties of a peer node. +// Configuration properties of a node. type NodeConfiguration struct { _ struct{} `type:"structure"` // The Availability Zone in which the node exists. - // - // AvailabilityZone is a required field - AvailabilityZone *string `type:"string" required:"true"` + AvailabilityZone *string `type:"string"` // The Amazon Managed Blockchain instance type for the node. // // InstanceType is a required field InstanceType *string `type:"string" required:"true"` - // Configuration properties for logging events associated with a peer node owned - // by a member in a Managed Blockchain network. + // Configuration properties for logging events associated with a peer node on + // a Hyperledger Fabric network on Managed Blockchain. LogPublishingConfiguration *NodeLogPublishingConfiguration `type:"structure"` // The state database that the node uses. Values are LevelDB or CouchDB. When // using an Amazon Managed Blockchain network with Hyperledger Fabric version // 1.4 or later, the default is CouchDB. + // + // Applies only to Hyperledger Fabric. StateDB *string `type:"string" enum:"StateDBType"` } @@ -5437,9 +5539,6 @@ func (s NodeConfiguration) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *NodeConfiguration) Validate() error { invalidParams := request.ErrInvalidParams{Context: "NodeConfiguration"} - if s.AvailabilityZone == nil { - invalidParams.Add(request.NewErrParamRequired("AvailabilityZone")) - } if s.InstanceType == nil { invalidParams.Add(request.NewErrParamRequired("InstanceType")) } @@ -5474,8 +5573,47 @@ func (s *NodeConfiguration) SetStateDB(v string) *NodeConfiguration { return s } -// Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain -// network that uses Hyperledger Fabric. +// Attributes of an Ethereum node. +type NodeEthereumAttributes struct { + _ struct{} `type:"structure"` + + // The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC + // methods over HTTP connections from a client. Use this endpoint in client + // code for smart contracts when using an HTTP connection. Connections to this + // endpoint are authenticated using Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). + HttpEndpoint *string `type:"string"` + + // The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC + // methods over WebSockets connections from a client. Use this endpoint in client + // code for smart contracts when using a WebSockets connection. Connections + // to this endpoint are authenticated using Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). + WebSocketEndpoint *string `type:"string"` +} + +// String returns the string representation +func (s NodeEthereumAttributes) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s NodeEthereumAttributes) GoString() string { + return s.String() +} + +// SetHttpEndpoint sets the HttpEndpoint field's value. +func (s *NodeEthereumAttributes) SetHttpEndpoint(v string) *NodeEthereumAttributes { + s.HttpEndpoint = &v + return s +} + +// SetWebSocketEndpoint sets the WebSocketEndpoint field's value. +func (s *NodeEthereumAttributes) SetWebSocketEndpoint(v string) *NodeEthereumAttributes { + s.WebSocketEndpoint = &v + return s +} + +// Attributes of Hyperledger Fabric for a peer node on a Hyperledger Fabric +// network on Managed Blockchain. type NodeFabricAttributes struct { _ struct{} `type:"structure"` @@ -5550,11 +5688,15 @@ func (s *NodeFabricLogPublishingConfiguration) SetPeerLogs(v *LogConfigurations) return s } -// Attributes relevant to a peer node on a Managed Blockchain network for the -// blockchain framework that the network uses. +// Attributes relevant to a node on a Managed Blockchain network for the blockchain +// framework that the network uses. type NodeFrameworkAttributes struct { _ struct{} `type:"structure"` + // Attributes of Ethereum for a node on a Managed Blockchain network that uses + // Ethereum. + Ethereum *NodeEthereumAttributes `type:"structure"` + // Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain // network that uses Hyperledger Fabric. Fabric *NodeFabricAttributes `type:"structure"` @@ -5570,14 +5712,20 @@ func (s NodeFrameworkAttributes) GoString() string { return s.String() } +// SetEthereum sets the Ethereum field's value. +func (s *NodeFrameworkAttributes) SetEthereum(v *NodeEthereumAttributes) *NodeFrameworkAttributes { + s.Ethereum = v + return s +} + // SetFabric sets the Fabric field's value. func (s *NodeFrameworkAttributes) SetFabric(v *NodeFabricAttributes) *NodeFrameworkAttributes { s.Fabric = v return s } -// Configuration properties for logging events associated with a peer node owned -// by a member in a Managed Blockchain network. +// Configuration properties for logging events associated with a peer node on +// a Hyperledger Fabric network on Managed Blockchain. type NodeLogPublishingConfiguration struct { _ struct{} `type:"structure"` @@ -5603,7 +5751,7 @@ func (s *NodeLogPublishingConfiguration) SetFabric(v *NodeFabricLogPublishingCon return s } -// A summary of configuration properties for a peer node. +// A summary of configuration properties for a node. type NodeSummary struct { _ struct{} `type:"structure"` @@ -5664,6 +5812,8 @@ func (s *NodeSummary) SetStatus(v string) *NodeSummary { } // Properties of a proposal on a Managed Blockchain network. +// +// Applies only to Hyperledger Fabric. type Proposal struct { _ struct{} `type:"structure"` @@ -5811,6 +5961,8 @@ func (s *Proposal) SetYesVoteCount(v int64) *Proposal { } // The actions to carry out if a proposal is APPROVED. +// +// Applies only to Hyperledger Fabric. type ProposalActions struct { _ struct{} `type:"structure"` @@ -5877,6 +6029,8 @@ func (s *ProposalActions) SetRemovals(v []*RemoveAction) *ProposalActions { } // Properties of a proposal. +// +// Applies only to Hyperledger Fabric. type ProposalSummary struct { _ struct{} `type:"structure"` @@ -6033,6 +6187,8 @@ func (s RejectInvitationOutput) GoString() string { // An action to remove a member from a Managed Blockchain network as the result // of a removal proposal that is APPROVED. The member and all associated resources // are deleted from the network. +// +// Applies only to Hyperledger Fabric. type RemoveAction struct { _ struct{} `type:"structure"` @@ -6367,12 +6523,13 @@ type UpdateMemberInput struct { // Configuration properties for publishing to Amazon CloudWatch Logs. LogPublishingConfiguration *MemberLogPublishingConfiguration `type:"structure"` - // The unique ID of the member. + // The unique identifier of the member. // // MemberId is a required field MemberId *string `location:"uri" locationName:"memberId" min:"1" type:"string" required:"true"` - // The unique ID of the Managed Blockchain network to which the member belongs. + // The unique identifier of the Managed Blockchain network to which the member + // belongs. // // NetworkId is a required field NetworkId *string `location:"uri" locationName:"networkId" min:"1" type:"string" required:"true"` @@ -6448,17 +6605,17 @@ type UpdateNodeInput struct { // Configuration properties for publishing to Amazon CloudWatch Logs. LogPublishingConfiguration *NodeLogPublishingConfiguration `type:"structure"` - // The unique ID of the member that owns the node. + // The unique identifier of the member that owns the node. // - // MemberId is a required field - MemberId *string `location:"uri" locationName:"memberId" min:"1" type:"string" required:"true"` + // Applies only to Hyperledger Fabric. + MemberId *string `min:"1" type:"string"` - // The unique ID of the Managed Blockchain network to which the node belongs. + // The unique identifier of the network that the node is on. // // NetworkId is a required field NetworkId *string `location:"uri" locationName:"networkId" min:"1" type:"string" required:"true"` - // The unique ID of the node. + // The unique identifier of the node. // // NodeId is a required field NodeId *string `location:"uri" locationName:"nodeId" min:"1" type:"string" required:"true"` @@ -6477,9 +6634,6 @@ func (s UpdateNodeInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *UpdateNodeInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "UpdateNodeInput"} - if s.MemberId == nil { - invalidParams.Add(request.NewErrParamRequired("MemberId")) - } if s.MemberId != nil && len(*s.MemberId) < 1 { invalidParams.Add(request.NewErrParamMinLen("MemberId", 1)) } @@ -6644,6 +6798,8 @@ func (s VoteOnProposalOutput) GoString() string { } // Properties of an individual vote that a member cast for a proposal. +// +// Applies only to Hyperledger Fabric. type VoteSummary struct { _ struct{} `type:"structure"` @@ -6686,6 +6842,8 @@ func (s *VoteSummary) SetVote(v string) *VoteSummary { } // The voting rules for the network to decide if a proposal is accepted +// +// Applies only to Hyperledger Fabric. type VotingPolicy struct { _ struct{} `type:"structure"` @@ -6746,12 +6904,16 @@ func Edition_Values() []string { const ( // FrameworkHyperledgerFabric is a Framework enum value FrameworkHyperledgerFabric = "HYPERLEDGER_FABRIC" + + // FrameworkEthereum is a Framework enum value + FrameworkEthereum = "ETHEREUM" ) // Framework_Values returns all elements of the Framework enum func Framework_Values() []string { return []string{ FrameworkHyperledgerFabric, + FrameworkEthereum, } } @@ -6850,6 +7012,9 @@ const ( // NodeStatusAvailable is a NodeStatus enum value NodeStatusAvailable = "AVAILABLE" + // NodeStatusUnhealthy is a NodeStatus enum value + NodeStatusUnhealthy = "UNHEALTHY" + // NodeStatusCreateFailed is a NodeStatus enum value NodeStatusCreateFailed = "CREATE_FAILED" @@ -6871,6 +7036,7 @@ func NodeStatus_Values() []string { return []string{ NodeStatusCreating, NodeStatusAvailable, + NodeStatusUnhealthy, NodeStatusCreateFailed, NodeStatusUpdating, NodeStatusDeleting, diff --git a/service/managedblockchain/doc.go b/service/managedblockchain/doc.go index 93f92b2185a..8b86bb639b0 100644 --- a/service/managedblockchain/doc.go +++ b/service/managedblockchain/doc.go @@ -4,11 +4,19 @@ // requests to Amazon Managed Blockchain. // // Amazon Managed Blockchain is a fully managed service for creating and managing -// blockchain networks using open source frameworks. Blockchain allows you to +// blockchain networks using open-source frameworks. Blockchain allows you to // build applications where multiple parties can securely and transparently // run transactions and share data without the need for a trusted, central authority. -// Currently, Managed Blockchain supports the Hyperledger Fabric open source -// framework. +// +// Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source +// frameworks. Because of fundamental differences between the frameworks, some +// API actions or data types may only apply in the context of one framework +// and not the other. For example, actions related to Hyperledger Fabric network +// members such as CreateMember and DeleteMember do not apply to Ethereum. +// +// The description for each action indicates the framework or frameworks to +// which it applies. Data types and properties that apply only in the context +// of a particular framework are similarly indicated. // // See https://docs.aws.amazon.com/goto/WebAPI/managedblockchain-2018-09-24 for more information on this service. // diff --git a/service/outposts/api.go b/service/outposts/api.go index 91f3d4251e9..cd84599628d 100644 --- a/service/outposts/api.go +++ b/service/outposts/api.go @@ -743,6 +743,263 @@ func (c *Outposts) ListSitesPagesWithContext(ctx aws.Context, input *ListSitesIn return p.Err() } +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListTagsForResource +func (c *Outposts) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS Outposts. +// +// Lists the tags for the specified resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Outposts's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// An internal error has occurred. +// +// * ValidationException +// A parameter is not valid. +// +// * NotFoundException +// The specified request is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListTagsForResource +func (c *Outposts) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Outposts) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/TagResource +func (c *Outposts) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for AWS Outposts. +// +// Adds tags to the specified resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Outposts's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// An internal error has occurred. +// +// * ValidationException +// A parameter is not valid. +// +// * NotFoundException +// The specified request is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/TagResource +func (c *Outposts) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Outposts) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/UntagResource +func (c *Outposts) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AWS Outposts. +// +// Removes tags from the specified resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Outposts's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// An internal error has occurred. +// +// * ValidationException +// A parameter is not valid. +// +// * NotFoundException +// The specified request is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/UntagResource +func (c *Outposts) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Outposts) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // You do not have permission to perform this operation. type AccessDeniedException struct { _ struct{} `type:"structure"` @@ -812,7 +1069,7 @@ type CreateOutpostInput struct { // You must specify AvailabilityZone or AvailabilityZoneId. AvailabilityZoneId *string `min:"1" type:"string"` - // The Outpost description. + // The description of the Outpost. Description *string `min:"1" type:"string"` // The name of the Outpost. @@ -1461,6 +1718,70 @@ func (s *ListSitesOutput) SetSites(v []*Site) *ListSitesOutput { return s } +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The resource tags. + Tags map[string]*string `min:"1" type:"map"` +} + +// String returns the string representation +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + // The specified request is not valid. type NotFoundException struct { _ struct{} `type:"structure"` @@ -1531,7 +1852,7 @@ type Outpost struct { // You must specify AvailabilityZone or AvailabilityZoneId. AvailabilityZoneId *string `min:"1" type:"string"` - // The Outpost description. + // The description of the Outpost. Description *string `min:"1" type:"string"` // The life cycle status. @@ -1742,6 +2063,150 @@ func (s *Site) SetTags(v map[string]*string) *Site { return s } +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` + + // The tags to add to the resource. + // + // Tags is a required field + Tags map[string]*string `min:"1" type:"map" required:"true"` +} + +// String returns the string representation +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceOutput) GoString() string { + return s.String() +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` + + // The tag keys. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + if s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + // A parameter is not valid. type ValidationException struct { _ struct{} `type:"structure"` diff --git a/service/outposts/doc.go b/service/outposts/doc.go index 135c1ea07dd..a360717ede6 100644 --- a/service/outposts/doc.go +++ b/service/outposts/doc.go @@ -3,8 +3,8 @@ // Package outposts provides the client and types for making API // requests to AWS Outposts. // -// AWS Outposts is a fully-managed service that extends AWS infrastructure, -// APIs, and tools to customer premises. By providing local access to AWS-managed +// AWS Outposts is a fully managed service that extends AWS infrastructure, +// APIs, and tools to customer premises. By providing local access to AWS managed // infrastructure, AWS Outposts enables customers to build and run applications // on premises using the same programming interfaces as in AWS Regions, while // using local compute and storage resources for lower latency and local data diff --git a/service/outposts/outpostsiface/interface.go b/service/outposts/outpostsiface/interface.go index 285b1136fab..b89818a4df0 100644 --- a/service/outposts/outpostsiface/interface.go +++ b/service/outposts/outpostsiface/interface.go @@ -93,6 +93,18 @@ type OutpostsAPI interface { ListSitesPages(*outposts.ListSitesInput, func(*outposts.ListSitesOutput, bool) bool) error ListSitesPagesWithContext(aws.Context, *outposts.ListSitesInput, func(*outposts.ListSitesOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*outposts.ListTagsForResourceInput) (*outposts.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *outposts.ListTagsForResourceInput, ...request.Option) (*outposts.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*outposts.ListTagsForResourceInput) (*request.Request, *outposts.ListTagsForResourceOutput) + + TagResource(*outposts.TagResourceInput) (*outposts.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *outposts.TagResourceInput, ...request.Option) (*outposts.TagResourceOutput, error) + TagResourceRequest(*outposts.TagResourceInput) (*request.Request, *outposts.TagResourceOutput) + + UntagResource(*outposts.UntagResourceInput) (*outposts.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *outposts.UntagResourceInput, ...request.Option) (*outposts.UntagResourceOutput, error) + UntagResourceRequest(*outposts.UntagResourceInput) (*request.Request, *outposts.UntagResourceOutput) } var _ OutpostsAPI = (*outposts.Outposts)(nil) diff --git a/service/qldbsession/api.go b/service/qldbsession/api.go index 6195a2c243d..92a3b363617 100644 --- a/service/qldbsession/api.go +++ b/service/qldbsession/api.go @@ -57,21 +57,20 @@ func (c *QLDBSession) SendCommandRequest(input *SendCommandInput) (req *request. // // Sends a command to an Amazon QLDB ledger. // -// Instead of interacting directly with this API, we recommend that you use -// the Amazon QLDB Driver or the QLDB Shell to execute data transactions on -// a ledger. +// Instead of interacting directly with this API, we recommend using the QLDB +// driver or the QLDB shell to execute data transactions on a ledger. // -// * If you are working with an AWS SDK, use the QLDB Driver. The driver -// provides a high-level abstraction layer above this qldbsession data plane +// * If you are working with an AWS SDK, use the QLDB driver. The driver +// provides a high-level abstraction layer above this QLDB Session data plane // and manages SendCommand API calls for you. For information and a list // of supported programming languages, see Getting started with the driver // (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html) // in the Amazon QLDB Developer Guide. // // * If you are working with the AWS Command Line Interface (AWS CLI), use -// the QLDB Shell. The shell is a command line interface that uses the QLDB -// Driver to interact with a ledger. For information, see Accessing Amazon -// QLDB using the QLDB Shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html). +// the QLDB shell. The shell is a command line interface that uses the QLDB +// driver to interact with a ledger. For information, see Accessing Amazon +// QLDB using the QLDB shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -138,6 +137,9 @@ func (s AbortTransactionRequest) GoString() string { // Contains the details of the aborted transaction. type AbortTransactionResult struct { _ struct{} `type:"structure"` + + // Contains server-side performance information for the command. + TimingInformation *TimingInformation `type:"structure"` } // String returns the string representation @@ -150,6 +152,12 @@ func (s AbortTransactionResult) GoString() string { return s.String() } +// SetTimingInformation sets the TimingInformation field's value. +func (s *AbortTransactionResult) SetTimingInformation(v *TimingInformation) *AbortTransactionResult { + s.TimingInformation = v + return s +} + // Returned if the request is malformed or contains an error such as an invalid // parameter value or a missing required parameter. type BadRequestException struct { @@ -218,6 +226,11 @@ type CommitTransactionRequest struct { // and rejects the commit with an error if the digest computed on the client // does not match the digest computed by QLDB. // + // The purpose of the CommitDigest parameter is to ensure that QLDB commits + // a transaction if and only if the server has processed the exact set of statements + // sent by the client, in the same order that client sent them, and with no + // duplicates. + // // CommitDigest is automatically base64 encoded/decoded by the SDK. // // CommitDigest is a required field @@ -279,6 +292,12 @@ type CommitTransactionResult struct { // CommitDigest is automatically base64 encoded/decoded by the SDK. CommitDigest []byte `type:"blob"` + // Contains metrics about the number of I/O requests that were consumed. + ConsumedIOs *IOUsage `type:"structure"` + + // Contains server-side performance information for the command. + TimingInformation *TimingInformation `type:"structure"` + // The transaction ID of the committed transaction. TransactionId *string `min:"22" type:"string"` } @@ -299,6 +318,18 @@ func (s *CommitTransactionResult) SetCommitDigest(v []byte) *CommitTransactionRe return s } +// SetConsumedIOs sets the ConsumedIOs field's value. +func (s *CommitTransactionResult) SetConsumedIOs(v *IOUsage) *CommitTransactionResult { + s.ConsumedIOs = v + return s +} + +// SetTimingInformation sets the TimingInformation field's value. +func (s *CommitTransactionResult) SetTimingInformation(v *TimingInformation) *CommitTransactionResult { + s.TimingInformation = v + return s +} + // SetTransactionId sets the TransactionId field's value. func (s *CommitTransactionResult) SetTransactionId(v string) *CommitTransactionResult { s.TransactionId = &v @@ -323,6 +354,9 @@ func (s EndSessionRequest) GoString() string { // Contains the details of the ended session. type EndSessionResult struct { _ struct{} `type:"structure"` + + // Contains server-side performance information for the command. + TimingInformation *TimingInformation `type:"structure"` } // String returns the string representation @@ -335,6 +369,12 @@ func (s EndSessionResult) GoString() string { return s.String() } +// SetTimingInformation sets the TimingInformation field's value. +func (s *EndSessionResult) SetTimingInformation(v *TimingInformation) *EndSessionResult { + s.TimingInformation = v + return s +} + // Specifies a request to execute a statement. type ExecuteStatementRequest struct { _ struct{} `type:"structure"` @@ -417,8 +457,14 @@ func (s *ExecuteStatementRequest) SetTransactionId(v string) *ExecuteStatementRe type ExecuteStatementResult struct { _ struct{} `type:"structure"` + // Contains metrics about the number of I/O requests that were consumed. + ConsumedIOs *IOUsage `type:"structure"` + // Contains the details of the first fetched page. FirstPage *Page `type:"structure"` + + // Contains server-side performance information for the command. + TimingInformation *TimingInformation `type:"structure"` } // String returns the string representation @@ -431,12 +477,24 @@ func (s ExecuteStatementResult) GoString() string { return s.String() } +// SetConsumedIOs sets the ConsumedIOs field's value. +func (s *ExecuteStatementResult) SetConsumedIOs(v *IOUsage) *ExecuteStatementResult { + s.ConsumedIOs = v + return s +} + // SetFirstPage sets the FirstPage field's value. func (s *ExecuteStatementResult) SetFirstPage(v *Page) *ExecuteStatementResult { s.FirstPage = v return s } +// SetTimingInformation sets the TimingInformation field's value. +func (s *ExecuteStatementResult) SetTimingInformation(v *TimingInformation) *ExecuteStatementResult { + s.TimingInformation = v + return s +} + // Specifies the details of the page to be fetched. type FetchPageRequest struct { _ struct{} `type:"structure"` @@ -500,8 +558,14 @@ func (s *FetchPageRequest) SetTransactionId(v string) *FetchPageRequest { type FetchPageResult struct { _ struct{} `type:"structure"` + // Contains metrics about the number of I/O requests that were consumed. + ConsumedIOs *IOUsage `type:"structure"` + // Contains details of the fetched page. Page *Page `type:"structure"` + + // Contains server-side performance information for the command. + TimingInformation *TimingInformation `type:"structure"` } // String returns the string representation @@ -514,12 +578,57 @@ func (s FetchPageResult) GoString() string { return s.String() } +// SetConsumedIOs sets the ConsumedIOs field's value. +func (s *FetchPageResult) SetConsumedIOs(v *IOUsage) *FetchPageResult { + s.ConsumedIOs = v + return s +} + // SetPage sets the Page field's value. func (s *FetchPageResult) SetPage(v *Page) *FetchPageResult { s.Page = v return s } +// SetTimingInformation sets the TimingInformation field's value. +func (s *FetchPageResult) SetTimingInformation(v *TimingInformation) *FetchPageResult { + s.TimingInformation = v + return s +} + +// Contains I/O usage metrics for a command that was invoked. +type IOUsage struct { + _ struct{} `type:"structure"` + + // The number of read I/O requests that the command performed. + ReadIOs *int64 `type:"long"` + + // The number of write I/O requests that the command performed. + WriteIOs *int64 `type:"long"` +} + +// String returns the string representation +func (s IOUsage) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s IOUsage) GoString() string { + return s.String() +} + +// SetReadIOs sets the ReadIOs field's value. +func (s *IOUsage) SetReadIOs(v int64) *IOUsage { + s.ReadIOs = &v + return s +} + +// SetWriteIOs sets the WriteIOs field's value. +func (s *IOUsage) SetWriteIOs(v int64) *IOUsage { + s.WriteIOs = &v + return s +} + // Returned if the session doesn't exist anymore because it timed out or expired. type InvalidSessionException struct { _ struct{} `type:"structure"` @@ -1033,6 +1142,9 @@ type StartSessionResult struct { // Session token of the started session. This SessionToken is required for every // subsequent command that is issued during the current session. SessionToken *string `min:"4" type:"string"` + + // Contains server-side performance information for the command. + TimingInformation *TimingInformation `type:"structure"` } // String returns the string representation @@ -1051,6 +1163,12 @@ func (s *StartSessionResult) SetSessionToken(v string) *StartSessionResult { return s } +// SetTimingInformation sets the TimingInformation field's value. +func (s *StartSessionResult) SetTimingInformation(v *TimingInformation) *StartSessionResult { + s.TimingInformation = v + return s +} + // Specifies a request to start a transaction. type StartTransactionRequest struct { _ struct{} `type:"structure"` @@ -1070,6 +1188,9 @@ func (s StartTransactionRequest) GoString() string { type StartTransactionResult struct { _ struct{} `type:"structure"` + // Contains server-side performance information for the command. + TimingInformation *TimingInformation `type:"structure"` + // The transaction ID of the started transaction. TransactionId *string `min:"22" type:"string"` } @@ -1084,13 +1205,46 @@ func (s StartTransactionResult) GoString() string { return s.String() } +// SetTimingInformation sets the TimingInformation field's value. +func (s *StartTransactionResult) SetTimingInformation(v *TimingInformation) *StartTransactionResult { + s.TimingInformation = v + return s +} + // SetTransactionId sets the TransactionId field's value. func (s *StartTransactionResult) SetTransactionId(v string) *StartTransactionResult { s.TransactionId = &v return s } -// A structure that can contain an Amazon Ion value in multiple encoding formats. +// Contains server-side performance information for a command. Amazon QLDB captures +// timing information between the times when it receives the request and when +// it sends the corresponding response. +type TimingInformation struct { + _ struct{} `type:"structure"` + + // The amount of time that was taken for the command to finish processing, measured + // in milliseconds. + ProcessingTimeMilliseconds *int64 `type:"long"` +} + +// String returns the string representation +func (s TimingInformation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TimingInformation) GoString() string { + return s.String() +} + +// SetProcessingTimeMilliseconds sets the ProcessingTimeMilliseconds field's value. +func (s *TimingInformation) SetProcessingTimeMilliseconds(v int64) *TimingInformation { + s.ProcessingTimeMilliseconds = &v + return s +} + +// A structure that can contain a value in multiple encoding formats. type ValueHolder struct { _ struct{} `type:"structure"` diff --git a/service/qldbsession/doc.go b/service/qldbsession/doc.go index 8b3837cb674..c8cd1740ad5 100644 --- a/service/qldbsession/doc.go +++ b/service/qldbsession/doc.go @@ -5,21 +5,20 @@ // // The transactional data APIs for Amazon QLDB // -// Instead of interacting directly with this API, we recommend that you use -// the Amazon QLDB Driver or the QLDB Shell to execute data transactions on -// a ledger. +// Instead of interacting directly with this API, we recommend using the QLDB +// driver or the QLDB shell to execute data transactions on a ledger. // -// * If you are working with an AWS SDK, use the QLDB Driver. The driver -// provides a high-level abstraction layer above this qldbsession data plane +// * If you are working with an AWS SDK, use the QLDB driver. The driver +// provides a high-level abstraction layer above this QLDB Session data plane // and manages SendCommand API calls for you. For information and a list // of supported programming languages, see Getting started with the driver // (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html) // in the Amazon QLDB Developer Guide. // // * If you are working with the AWS Command Line Interface (AWS CLI), use -// the QLDB Shell. The shell is a command line interface that uses the QLDB -// Driver to interact with a ledger. For information, see Accessing Amazon -// QLDB using the QLDB Shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html). +// the QLDB shell. The shell is a command line interface that uses the QLDB +// driver to interact with a ledger. For information, see Accessing Amazon +// QLDB using the QLDB shell (https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html). // // See https://docs.aws.amazon.com/goto/WebAPI/qldb-session-2019-07-11 for more information on this service. // diff --git a/service/s3/api.go b/service/s3/api.go index 66700cce13d..89a0a29afff 100644 --- a/service/s3/api.go +++ b/service/s3/api.go @@ -19563,7 +19563,7 @@ type GetObjectInput struct { ResponseContentType *string `location:"querystring" locationName:"response-content-type" type:"string"` // Sets the Expires header of the response. - ResponseExpires *time.Time `location:"querystring" locationName:"response-expires" type:"timestamp"` + ResponseExpires *time.Time `location:"querystring" locationName:"response-expires" type:"timestamp" timestampFormat:"rfc822"` // Specifies the algorithm to use to when encrypting the object (for example, // AES256). diff --git a/service/s3/examples_test.go b/service/s3/examples_test.go index 1597908b21f..26abe5f4c25 100644 --- a/service/s3/examples_test.go +++ b/service/s3/examples_test.go @@ -128,17 +128,13 @@ func ExampleS3_CopyObject_shared00() { fmt.Println(result) } -// To create a bucket in a specific region +// To create a bucket // -// The following example creates a bucket. The request specifies an AWS region where -// to create the bucket. +// The following example creates a bucket. func ExampleS3_CreateBucket_shared00() { svc := s3.New(session.New()) input := &s3.CreateBucketInput{ Bucket: aws.String("examplebucket"), - CreateBucketConfiguration: &s3.CreateBucketConfiguration{ - LocationConstraint: aws.String("eu-west-1"), - }, } result, err := svc.CreateBucket(input) @@ -163,13 +159,17 @@ func ExampleS3_CreateBucket_shared00() { fmt.Println(result) } -// To create a bucket +// To create a bucket in a specific region // -// The following example creates a bucket. +// The following example creates a bucket. The request specifies an AWS region where +// to create the bucket. func ExampleS3_CreateBucket_shared01() { svc := s3.New(session.New()) input := &s3.CreateBucketInput{ Bucket: aws.String("examplebucket"), + CreateBucketConfiguration: &s3.CreateBucketConfiguration{ + LocationConstraint: aws.String("eu-west-1"), + }, } result, err := svc.CreateBucket(input) @@ -467,16 +467,16 @@ func ExampleS3_DeleteObject_shared01() { fmt.Println(result) } -// To remove tag set from an object +// To remove tag set from an object version // -// The following example removes tag set associated with the specified object. If the -// bucket is versioning enabled, the operation removes tag set from the latest object -// version. +// The following example removes tag set associated with the specified object version. +// The request specifies both the object key and object version. func ExampleS3_DeleteObjectTagging_shared00() { svc := s3.New(session.New()) input := &s3.DeleteObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), } result, err := svc.DeleteObjectTagging(input) @@ -497,16 +497,16 @@ func ExampleS3_DeleteObjectTagging_shared00() { fmt.Println(result) } -// To remove tag set from an object version +// To remove tag set from an object // -// The following example removes tag set associated with the specified object version. -// The request specifies both the object key and object version. +// The following example removes tag set associated with the specified object. If the +// bucket is versioning enabled, the operation removes tag set from the latest object +// version. func ExampleS3_DeleteObjectTagging_shared01() { svc := s3.New(session.New()) input := &s3.DeleteObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.DeleteObjectTagging(input) @@ -527,11 +527,11 @@ func ExampleS3_DeleteObjectTagging_shared01() { fmt.Println(result) } -// To delete multiple objects from a versioned bucket +// To delete multiple object versions from a versioned bucket // -// The following example deletes objects from a bucket. The bucket is versioned, and -// the request does not specify the object version to delete. In this case, all versions -// remain in the bucket and S3 adds a delete marker. +// The following example deletes objects from a bucket. The request specifies object +// versions. S3 deletes specific object versions and returns the key and versions of +// deleted objects in the response. func ExampleS3_DeleteObjects_shared00() { svc := s3.New(session.New()) input := &s3.DeleteObjectsInput{ @@ -539,10 +539,12 @@ func ExampleS3_DeleteObjects_shared00() { Delete: &s3.Delete{ Objects: []*s3.ObjectIdentifier{ { - Key: aws.String("objectkey1"), + Key: aws.String("HappyFace.jpg"), + VersionId: aws.String("2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"), }, { - Key: aws.String("objectkey2"), + Key: aws.String("HappyFace.jpg"), + VersionId: aws.String("yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"), }, }, Quiet: aws.Bool(false), @@ -567,11 +569,11 @@ func ExampleS3_DeleteObjects_shared00() { fmt.Println(result) } -// To delete multiple object versions from a versioned bucket +// To delete multiple objects from a versioned bucket // -// The following example deletes objects from a bucket. The request specifies object -// versions. S3 deletes specific object versions and returns the key and versions of -// deleted objects in the response. +// The following example deletes objects from a bucket. The bucket is versioned, and +// the request does not specify the object version to delete. In this case, all versions +// remain in the bucket and S3 adds a delete marker. func ExampleS3_DeleteObjects_shared01() { svc := s3.New(session.New()) input := &s3.DeleteObjectsInput{ @@ -579,12 +581,10 @@ func ExampleS3_DeleteObjects_shared01() { Delete: &s3.Delete{ Objects: []*s3.ObjectIdentifier{ { - Key: aws.String("HappyFace.jpg"), - VersionId: aws.String("2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"), + Key: aws.String("objectkey1"), }, { - Key: aws.String("HappyFace.jpg"), - VersionId: aws.String("yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"), + Key: aws.String("objectkey2"), }, }, Quiet: aws.Bool(false), @@ -934,14 +934,16 @@ func ExampleS3_GetBucketWebsite_shared00() { fmt.Println(result) } -// To retrieve an object +// To retrieve a byte range of an object // -// The following example retrieves an object for an S3 bucket. +// The following example retrieves an object for an S3 bucket. The request specifies +// the range header to retrieve a specific byte range. func ExampleS3_GetObject_shared00() { svc := s3.New(session.New()) input := &s3.GetObjectInput{ Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Key: aws.String("SampleFile.txt"), + Range: aws.String("bytes=0-9"), } result, err := svc.GetObject(input) @@ -966,16 +968,14 @@ func ExampleS3_GetObject_shared00() { fmt.Println(result) } -// To retrieve a byte range of an object +// To retrieve an object // -// The following example retrieves an object for an S3 bucket. The request specifies -// the range header to retrieve a specific byte range. +// The following example retrieves an object for an S3 bucket. func ExampleS3_GetObject_shared01() { svc := s3.New(session.New()) input := &s3.GetObjectInput{ Bucket: aws.String("examplebucket"), - Key: aws.String("SampleFile.txt"), - Range: aws.String("bytes=0-9"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.GetObject(input) @@ -1808,17 +1808,19 @@ func ExampleS3_PutBucketWebsite_shared00() { fmt.Println(result) } -// To upload an object +// To upload an object and specify server-side encryption and object tags // -// The following example uploads an object to a versioning-enabled bucket. The source -// file is specified using Windows file syntax. S3 returns VersionId of the newly created -// object. +// The following example uploads and object. The request specifies the optional server-side +// encryption option. The request also specifies optional object tags. If the bucket +// is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared00() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + ServerSideEncryption: aws.String("AES256"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input) @@ -1839,18 +1841,16 @@ func ExampleS3_PutObject_shared00() { fmt.Println(result) } -// To upload an object and specify canned ACL. +// To create an object. // -// The following example uploads and object. The request specifies optional canned ACL -// (access control list) to all READ access to authenticated users. If the bucket is -// versioning enabled, S3 returns version ID in response. +// The following example creates an object. If the bucket is versioning enabled, S3 +// returns version ID in response. func ExampleS3_PutObject_shared01() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - ACL: aws.String("authenticated-read"), Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), + Key: aws.String("objectkey"), } result, err := svc.PutObject(input) @@ -1871,18 +1871,17 @@ func ExampleS3_PutObject_shared01() { fmt.Println(result) } -// To upload an object (specify optional headers) +// To upload an object and specify optional tags // -// The following example uploads an object. The request specifies optional request headers -// to directs S3 to use specific storage class and use server-side encryption. +// The following example uploads an object. The request specifies optional object tags. +// The bucket is versioned, therefore S3 returns version ID of the newly created object. func ExampleS3_PutObject_shared02() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - ServerSideEncryption: aws.String("AES256"), - StorageClass: aws.String("STANDARD_IA"), + Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input) @@ -1903,19 +1902,18 @@ func ExampleS3_PutObject_shared02() { fmt.Println(result) } -// To upload an object and specify server-side encryption and object tags +// To upload an object (specify optional headers) // -// The following example uploads and object. The request specifies the optional server-side -// encryption option. The request also specifies optional object tags. If the bucket -// is versioning enabled, S3 returns version ID in response. +// The following example uploads an object. The request specifies optional request headers +// to directs S3 to use specific storage class and use server-side encryption. func ExampleS3_PutObject_shared03() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), + Key: aws.String("HappyFace.jpg"), ServerSideEncryption: aws.String("AES256"), - Tagging: aws.String("key1=value1&key2=value2"), + StorageClass: aws.String("STANDARD_IA"), } result, err := svc.PutObject(input) @@ -1936,16 +1934,20 @@ func ExampleS3_PutObject_shared03() { fmt.Println(result) } -// To create an object. +// To upload object and specify user-defined metadata // -// The following example creates an object. If the bucket is versioning enabled, S3 -// returns version ID in response. +// The following example creates an object. The request also specifies optional metadata. +// If the bucket is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared04() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), Bucket: aws.String("examplebucket"), - Key: aws.String("objectkey"), + Key: aws.String("exampleobject"), + Metadata: map[string]*string{ + "metadata1": aws.String("value1"), + "metadata2": aws.String("value2"), + }, } result, err := svc.PutObject(input) @@ -1966,20 +1968,18 @@ func ExampleS3_PutObject_shared04() { fmt.Println(result) } -// To upload object and specify user-defined metadata +// To upload an object and specify canned ACL. // -// The following example creates an object. The request also specifies optional metadata. -// If the bucket is versioning enabled, S3 returns version ID in response. +// The following example uploads and object. The request specifies optional canned ACL +// (access control list) to all READ access to authenticated users. If the bucket is +// versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared05() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ + ACL: aws.String("authenticated-read"), Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), Bucket: aws.String("examplebucket"), Key: aws.String("exampleobject"), - Metadata: map[string]*string{ - "metadata1": aws.String("value1"), - "metadata2": aws.String("value2"), - }, } result, err := svc.PutObject(input) @@ -2000,17 +2000,17 @@ func ExampleS3_PutObject_shared05() { fmt.Println(result) } -// To upload an object and specify optional tags +// To upload an object // -// The following example uploads an object. The request specifies optional object tags. -// The bucket is versioned, therefore S3 returns version ID of the newly created object. +// The following example uploads an object to a versioning-enabled bucket. The source +// file is specified using Windows file syntax. S3 returns VersionId of the newly created +// object. func ExampleS3_PutObject_shared06() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - Tagging: aws.String("key1=value1&key2=value2"), + Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.PutObject(input) diff --git a/service/securityhub/api.go b/service/securityhub/api.go index 6d2156ef56d..5f45a6d2649 100644 --- a/service/securityhub/api.go +++ b/service/securityhub/api.go @@ -365,24 +365,29 @@ func (c *SecurityHub) BatchImportFindingsRequest(input *BatchImportFindingsInput // the following finding fields and objects, which Security Hub customers use // to manage their investigation workflow. // +// * Note +// +// * UserDefinedFields +// +// * VerificationState +// +// * Workflow +// +// BatchImportFindings can be used to update the following finding fields and +// objects only if they have not been updated using BatchUpdateFindings. After +// they are updated using BatchUpdateFindings, these fields cannot be updated +// using BatchImportFindings. +// // * Confidence // // * Criticality // -// * Note -// // * RelatedFindings // // * Severity // // * Types // -// * UserDefinedFields -// -// * VerificationState -// -// * Workflow -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -23518,9 +23523,8 @@ func (s *Result) SetProcessingResult(v string) *Result { // The severity of the finding. // -// The finding provider can provide the initial severity, but cannot update -// it after that. The severity can only be updated by a master account. It cannot -// be updated by a member account. +// The finding provider can provide the initial severity. The finding provider +// can only update the severity if it has not been updated using BatchUpdateFindings. // // The finding must have either Label or Normalized populated. If only one of // these attributes is populated, then Security Hub automatically populates diff --git a/service/servicequotas/api.go b/service/servicequotas/api.go index 0d705da1a49..4ff4474a66d 100644 --- a/service/servicequotas/api.go +++ b/service/servicequotas/api.go @@ -58,12 +58,10 @@ func (c *ServiceQuotas) AssociateServiceQuotaTemplateRequest(input *AssociateSer // AssociateServiceQuotaTemplate API operation for Service Quotas. // -// Associates the Service Quotas template with your organization so that when -// new accounts are created in your organization, the template submits increase -// requests for the specified service quotas. Use the Service Quotas template -// to request an increase for any adjustable quota value. After you define the -// Service Quotas template, use this operation to associate, or enable, the -// template. +// Associates your quota request template with your organization. When a new +// account is created in your organization, the quota increase requests in the +// template are automatically applied to the account. You can add a quota increase +// request for any adjustable quota to your template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -77,7 +75,7 @@ func (c *ServiceQuotas) AssociateServiceQuotaTemplateRequest(input *AssociateSer // You can't perform this action because a dependency does not have access. // // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * ServiceException // Something went wrong. @@ -88,15 +86,13 @@ func (c *ServiceQuotas) AssociateServiceQuotaTemplateRequest(input *AssociateSer // // * AWSServiceAccessNotEnabledException // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. // // * OrganizationNotInAllFeaturesModeException -// The organization that your account belongs to, is not in All Features mode. -// To enable all features mode, see EnableAllFeatures (https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAllFeatures.html). +// The organization that your account belongs to is not in All Features mode. // // * TemplatesNotAvailableInRegionException -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// The Service Quotas template is not available in this AWS Region. // // * NoAvailableOrganizationException // The account making this call is not a member of an organization. @@ -168,7 +164,8 @@ func (c *ServiceQuotas) DeleteServiceQuotaIncreaseRequestFromTemplateRequest(inp // DeleteServiceQuotaIncreaseRequestFromTemplate API operation for Service Quotas. // -// Removes a service quota increase request from the Service Quotas template. +// Deletes the quota increase request for the specified quota from your quota +// request template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -179,7 +176,7 @@ func (c *ServiceQuotas) DeleteServiceQuotaIncreaseRequestFromTemplateRequest(inp // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * ServiceException // Something went wrong. @@ -199,11 +196,10 @@ func (c *ServiceQuotas) DeleteServiceQuotaIncreaseRequestFromTemplateRequest(inp // // * AWSServiceAccessNotEnabledException // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. // // * TemplatesNotAvailableInRegionException -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// The Service Quotas template is not available in this AWS Region. // // * NoAvailableOrganizationException // The account making this call is not a member of an organization. @@ -275,15 +271,10 @@ func (c *ServiceQuotas) DisassociateServiceQuotaTemplateRequest(input *Disassoci // DisassociateServiceQuotaTemplate API operation for Service Quotas. // -// Disables the Service Quotas template. Once the template is disabled, it does -// not request quota increases for new accounts in your organization. Disabling -// the quota template does not apply the quota increase requests from the template. -// -// Related operations -// -// * To enable the quota template, call AssociateServiceQuotaTemplate. -// -// * To delete a specific service quota from the template, use DeleteServiceQuotaIncreaseRequestFromTemplate. +// Disables your quota request template. After a template is disabled, the quota +// increase requests in the template are not applied to new accounts in your +// organization. Disabling a quota request template does not apply its quota +// increase requests. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -299,10 +290,8 @@ func (c *ServiceQuotas) DisassociateServiceQuotaTemplateRequest(input *Disassoci // * ServiceQuotaTemplateNotInUseException // The quota request template is not associated with your organization. // -// To use the template, call AssociateServiceQuotaTemplate. -// // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * ServiceException // Something went wrong. @@ -313,11 +302,10 @@ func (c *ServiceQuotas) DisassociateServiceQuotaTemplateRequest(input *Disassoci // // * AWSServiceAccessNotEnabledException // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. // // * TemplatesNotAvailableInRegionException -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// The Service Quotas template is not available in this AWS Region. // // * NoAvailableOrganizationException // The account making this call is not a member of an organization. @@ -388,8 +376,8 @@ func (c *ServiceQuotas) GetAWSDefaultServiceQuotaRequest(input *GetAWSDefaultSer // GetAWSDefaultServiceQuota API operation for Service Quotas. // -// Retrieves the default service quotas values. The Value returned for each -// quota is the AWS default value, even if the quotas have been increased.. +// Retrieves the default value for the specified quota. The default value does +// not reflect any quota increases. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -400,7 +388,7 @@ func (c *ServiceQuotas) GetAWSDefaultServiceQuotaRequest(input *GetAWSDefaultSer // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -481,9 +469,7 @@ func (c *ServiceQuotas) GetAssociationForServiceQuotaTemplateRequest(input *GetA // GetAssociationForServiceQuotaTemplate API operation for Service Quotas. // -// Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. -// Use this action to determine if the Service Quota template is associated, -// or enabled. +// Retrieves the status of the association for the quota request template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -499,10 +485,8 @@ func (c *ServiceQuotas) GetAssociationForServiceQuotaTemplateRequest(input *GetA // * ServiceQuotaTemplateNotInUseException // The quota request template is not associated with your organization. // -// To use the template, call AssociateServiceQuotaTemplate. -// // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * ServiceException // Something went wrong. @@ -513,11 +497,10 @@ func (c *ServiceQuotas) GetAssociationForServiceQuotaTemplateRequest(input *GetA // // * AWSServiceAccessNotEnabledException // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. // // * TemplatesNotAvailableInRegionException -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// The Service Quotas template is not available in this AWS Region. // // * NoAvailableOrganizationException // The account making this call is not a member of an organization. @@ -588,7 +571,7 @@ func (c *ServiceQuotas) GetRequestedServiceQuotaChangeRequest(input *GetRequeste // GetRequestedServiceQuotaChange API operation for Service Quotas. // -// Retrieves the details for a particular increase request. +// Retrieves information about the specified quota increase request. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -599,7 +582,7 @@ func (c *ServiceQuotas) GetRequestedServiceQuotaChangeRequest(input *GetRequeste // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -680,10 +663,9 @@ func (c *ServiceQuotas) GetServiceQuotaRequest(input *GetServiceQuotaInput) (req // GetServiceQuota API operation for Service Quotas. // -// Returns the details for the specified service quota. This operation provides -// a different Value than the GetAWSDefaultServiceQuota operation. This operation -// returns the applied value for each quota. GetAWSDefaultServiceQuota returns -// the default AWS value for each quota. +// Retrieves the applied quota value for the specified quota. For some quotas, +// only the default values are available. If the applied quota value is not +// available for a quota, the quota is not retrieved. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -694,7 +676,7 @@ func (c *ServiceQuotas) GetServiceQuotaRequest(input *GetServiceQuotaInput) (req // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -775,7 +757,8 @@ func (c *ServiceQuotas) GetServiceQuotaIncreaseRequestFromTemplateRequest(input // GetServiceQuotaIncreaseRequestFromTemplate API operation for Service Quotas. // -// Returns the details of the service quota increase request in your template. +// Retrieves information about the specified quota increase request in your +// quota request template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -786,7 +769,7 @@ func (c *ServiceQuotas) GetServiceQuotaIncreaseRequestFromTemplateRequest(input // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * DependencyAccessDeniedException // You can't perform this action because a dependency does not have access. @@ -806,11 +789,10 @@ func (c *ServiceQuotas) GetServiceQuotaIncreaseRequestFromTemplateRequest(input // // * AWSServiceAccessNotEnabledException // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. // // * TemplatesNotAvailableInRegionException -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// The Service Quotas template is not available in this AWS Region. // // * NoAvailableOrganizationException // The account making this call is not a member of an organization. @@ -887,18 +869,8 @@ func (c *ServiceQuotas) ListAWSDefaultServiceQuotasRequest(input *ListAWSDefault // ListAWSDefaultServiceQuotas API operation for Service Quotas. // -// Lists all default service quotas for the specified AWS service or all AWS -// services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except -// for the Value object. The Value object returned by ListAWSDefaultServiceQuotas -// is the default value assigned by AWS. This request returns a list of all -// service quotas for the specified service. The listing of each you'll see -// the default values are the values that AWS provides for the quotas. -// -// Always check the NextToken response parameter when calling any of the List* -// operations. These operations can return an unexpected list of results, even -// when there are more results available. When this happens, the NextToken response -// parameter contains a value to pass the next call to the same API to request -// the next part of the list. +// Lists the default values for the quotas for the specified AWS service. A +// default value does not reflect any quota increases. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -909,7 +881,7 @@ func (c *ServiceQuotas) ListAWSDefaultServiceQuotasRequest(input *ListAWSDefault // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -1051,7 +1023,7 @@ func (c *ServiceQuotas) ListRequestedServiceQuotaChangeHistoryRequest(input *Lis // ListRequestedServiceQuotaChangeHistory API operation for Service Quotas. // -// Requests a list of the changes to quotas for a service. +// Retrieves the quota increase requests for the specified service. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1062,7 +1034,7 @@ func (c *ServiceQuotas) ListRequestedServiceQuotaChangeHistoryRequest(input *Lis // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -1204,10 +1176,7 @@ func (c *ServiceQuotas) ListRequestedServiceQuotaChangeHistoryByQuotaRequest(inp // ListRequestedServiceQuotaChangeHistoryByQuota API operation for Service Quotas. // -// Requests a list of the changes to specific service quotas. This command provides -// additional granularity over the ListRequestedServiceQuotaChangeHistory command. -// Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, -// the history has been kept for 90 days. +// Retrieves the quota increase requests for the specified quota. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1218,7 +1187,7 @@ func (c *ServiceQuotas) ListRequestedServiceQuotaChangeHistoryByQuotaRequest(inp // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -1360,7 +1329,7 @@ func (c *ServiceQuotas) ListServiceQuotaIncreaseRequestsInTemplateRequest(input // ListServiceQuotaIncreaseRequestsInTemplate API operation for Service Quotas. // -// Returns a list of the quota increase requests in the template. +// Lists the quota increase requests in the specified quota request template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1371,7 +1340,7 @@ func (c *ServiceQuotas) ListServiceQuotaIncreaseRequestsInTemplateRequest(input // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * DependencyAccessDeniedException // You can't perform this action because a dependency does not have access. @@ -1388,11 +1357,10 @@ func (c *ServiceQuotas) ListServiceQuotaIncreaseRequestsInTemplateRequest(input // // * AWSServiceAccessNotEnabledException // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. // // * TemplatesNotAvailableInRegionException -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// The Service Quotas template is not available in this AWS Region. // // * NoAvailableOrganizationException // The account making this call is not a member of an organization. @@ -1521,15 +1489,9 @@ func (c *ServiceQuotas) ListServiceQuotasRequest(input *ListServiceQuotasInput) // ListServiceQuotas API operation for Service Quotas. // -// Lists all service quotas for the specified AWS service. This request returns -// a list of the service quotas for the specified service. you'll see the default -// values are the values that AWS provides for the quotas. -// -// Always check the NextToken response parameter when calling any of the List* -// operations. These operations can return an unexpected list of results, even -// when there are more results available. When this happens, the NextToken response -// parameter contains a value to pass the next call to the same API to request -// the next part of the list. +// Lists the applied quota values for the specified AWS service. For some quotas, +// only the default values are available. If the applied quota value is not +// available for a quota, the quota is not retrieved. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1540,7 +1502,7 @@ func (c *ServiceQuotas) ListServiceQuotasRequest(input *ListServiceQuotasInput) // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -1682,9 +1644,7 @@ func (c *ServiceQuotas) ListServicesRequest(input *ListServicesInput) (req *requ // ListServices API operation for Service Quotas. // -// Lists the AWS services available in Service Quotas. Not all AWS services -// are available in Service Quotas. To list the see the list of the service -// quotas for a specific service, use ListServiceQuotas. +// Lists the names and codes for the services integrated with Service Quotas. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1695,7 +1655,7 @@ func (c *ServiceQuotas) ListServicesRequest(input *ListServicesInput) (req *requ // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * IllegalArgumentException // Invalid input was provided. @@ -1784,6 +1744,98 @@ func (c *ServiceQuotas) ListServicesPagesWithContext(ctx aws.Context, input *Lis return p.Err() } +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListTagsForResource +func (c *ServiceQuotas) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for Service Quotas. +// +// Returns a list of the tags assigned to the specified applied quota. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Service Quotas's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * TooManyRequestsException +// Due to throttling, the request was denied. Slow down the rate of request +// calls, or request an increase for this quota. +// +// * NoSuchResourceException +// The specified resource does not exist. +// +// * IllegalArgumentException +// Invalid input was provided. +// +// * AccessDeniedException +// You do not have sufficient permission to perform this action. +// +// * ServiceException +// Something went wrong. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListTagsForResource +func (c *ServiceQuotas) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ServiceQuotas) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opPutServiceQuotaIncreaseRequestIntoTemplate = "PutServiceQuotaIncreaseRequestIntoTemplate" // PutServiceQuotaIncreaseRequestIntoTemplateRequest generates a "aws/request.Request" representing the @@ -1828,10 +1880,7 @@ func (c *ServiceQuotas) PutServiceQuotaIncreaseRequestIntoTemplateRequest(input // PutServiceQuotaIncreaseRequestIntoTemplate API operation for Service Quotas. // -// Defines and adds a quota to the service quota template. To add a quota to -// the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and -// DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate -// to see the list of quotas in the template. +// Adds a quota increase request to your quota request template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1842,7 +1891,7 @@ func (c *ServiceQuotas) PutServiceQuotaIncreaseRequestIntoTemplateRequest(input // // Returned Error Types: // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * DependencyAccessDeniedException // You can't perform this action because a dependency does not have access. @@ -1867,11 +1916,10 @@ func (c *ServiceQuotas) PutServiceQuotaIncreaseRequestIntoTemplateRequest(input // // * AWSServiceAccessNotEnabledException // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. // // * TemplatesNotAvailableInRegionException -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// The Service Quotas template is not available in this AWS Region. // // * NoAvailableOrganizationException // The account making this call is not a member of an organization. @@ -1942,8 +1990,7 @@ func (c *ServiceQuotas) RequestServiceQuotaIncreaseRequest(input *RequestService // RequestServiceQuotaIncrease API operation for Service Quotas. // -// Retrieves the details of a service quota increase request. The response to -// this command provides the details in the RequestedServiceQuotaChange object. +// Submits a quota increase request for the specified quota. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1965,7 +2012,7 @@ func (c *ServiceQuotas) RequestServiceQuotaIncreaseRequest(input *RequestService // The specified resource already exists. // // * AccessDeniedException -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. // // * NoSuchResourceException // The specified resource does not exist. @@ -1974,7 +2021,7 @@ func (c *ServiceQuotas) RequestServiceQuotaIncreaseRequest(input *RequestService // Invalid input was provided. // // * InvalidResourceStateException -// Invalid input was provided for the . +// The resource is in an invalid state. // // * ServiceException // Something went wrong. @@ -2005,8 +2052,204 @@ func (c *ServiceQuotas) RequestServiceQuotaIncreaseWithContext(ctx aws.Context, return out, req.Send() } +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/TagResource +func (c *ServiceQuotas) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for Service Quotas. +// +// Adds tags to the specified applied quota. You can include one or more tags +// to add to the quota. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Service Quotas's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * TooManyRequestsException +// Due to throttling, the request was denied. Slow down the rate of request +// calls, or request an increase for this quota. +// +// * NoSuchResourceException +// The specified resource does not exist. +// +// * TooManyTagsException +// You've exceeded the number of tags allowed for a resource. For more information, +// see Tag restrictions (https://docs.aws.amazon.com/servicequotas/latest/userguide/sq-tagging.html#sq-tagging-restrictions) +// in the Service Quotas User Guide. +// +// * TagPolicyViolationException +// The specified tag is a reserved word and cannot be used. +// +// * IllegalArgumentException +// Invalid input was provided. +// +// * AccessDeniedException +// You do not have sufficient permission to perform this action. +// +// * ServiceException +// Something went wrong. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/TagResource +func (c *ServiceQuotas) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ServiceQuotas) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/UntagResource +func (c *ServiceQuotas) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for Service Quotas. +// +// Removes tags from the specified applied quota. You can specify one or more +// tags to remove. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Service Quotas's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * TooManyRequestsException +// Due to throttling, the request was denied. Slow down the rate of request +// calls, or request an increase for this quota. +// +// * NoSuchResourceException +// The specified resource does not exist. +// +// * IllegalArgumentException +// Invalid input was provided. +// +// * AccessDeniedException +// You do not have sufficient permission to perform this action. +// +// * ServiceException +// Something went wrong. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/UntagResource +func (c *ServiceQuotas) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ServiceQuotas) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // The action you attempted is not allowed unless Service Access with Service -// Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. +// Quotas is enabled in your organization. type AWSServiceAccessNotEnabledException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2062,7 +2305,7 @@ func (s *AWSServiceAccessNotEnabledException) RequestID() string { return s.RespMetadata.RequestID } -// You do not have sufficient access to perform this action. +// You do not have sufficient permission to perform this action. type AccessDeniedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2149,17 +2392,17 @@ func (s AssociateServiceQuotaTemplateOutput) GoString() string { type DeleteServiceQuotaIncreaseRequestFromTemplateInput struct { _ struct{} `type:"structure"` - // Specifies the AWS Region for the quota that you want to delete. + // The AWS Region. // // AwsRegion is a required field AwsRegion *string `min:"1" type:"string" required:"true"` - // Specifies the code for the quota that you want to delete. + // The quota identifier. // // QuotaCode is a required field QuotaCode *string `min:"1" type:"string" required:"true"` - // Specifies the code for the service that you want to delete. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -2319,27 +2562,24 @@ func (s DisassociateServiceQuotaTemplateOutput) GoString() string { return s.String() } -// Returns an error that explains why the action did not succeed. +// An error that explains why an action did not succeed. type ErrorReason struct { _ struct{} `type:"structure"` - // Service Quotas returns the following error values. + // Service Quotas returns the following error values: // - // DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have - // permission to call the service or service quota. To resolve the error, you - // need permission to access the service or service quota. + // * DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required + // permissions to complete the action. To resolve the error, you must have + // permission to access the service or quota. // - // DEPENDENCY_THROTTLING_ERROR is returned when the service being called is - // throttling Service Quotas. + // * DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas. // - // DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability - // issues. + // * DEPENDENCY_SERVICE_ERROR - The service is not available. // - // SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in - // Service Quotas. + // * SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas. ErrorCode *string `type:"string" enum:"ErrorCode"` - // The error message that provides more detail. + // The error message. ErrorMessage *string `type:"string"` } @@ -2368,12 +2608,12 @@ func (s *ErrorReason) SetErrorMessage(v string) *ErrorReason { type GetAWSDefaultServiceQuotaInput struct { _ struct{} `type:"structure"` - // Identifies the service quota you want to select. + // The quota identifier. // // QuotaCode is a required field QuotaCode *string `min:"1" type:"string" required:"true"` - // Specifies the service that you want to use. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -2426,7 +2666,7 @@ func (s *GetAWSDefaultServiceQuotaInput) SetServiceCode(v string) *GetAWSDefault type GetAWSDefaultServiceQuotaOutput struct { _ struct{} `type:"structure"` - // Returns the ServiceQuota object which contains all values for a quota. + // Information about the quota. Quota *ServiceQuota `type:"structure"` } @@ -2463,9 +2703,8 @@ func (s GetAssociationForServiceQuotaTemplateInput) GoString() string { type GetAssociationForServiceQuotaTemplateOutput struct { _ struct{} `type:"structure"` - // Specifies whether the template is ASSOCIATED or DISASSOCIATED. If the template - // is ASSOCIATED, then it requests service quota increases for all new accounts - // created in your organization. + // The association status. If the status is ASSOCIATED, the quota increase requests + // in the template are automatically applied to new accounts in your organization. ServiceQuotaTemplateAssociationStatus *string `type:"string" enum:"ServiceQuotaTemplateAssociationStatus"` } @@ -2488,7 +2727,7 @@ func (s *GetAssociationForServiceQuotaTemplateOutput) SetServiceQuotaTemplateAss type GetRequestedServiceQuotaChangeInput struct { _ struct{} `type:"structure"` - // Identifies the quota increase request. + // The ID of the quota increase request. // // RequestId is a required field RequestId *string `min:"1" type:"string" required:"true"` @@ -2529,8 +2768,7 @@ func (s *GetRequestedServiceQuotaChangeInput) SetRequestId(v string) *GetRequest type GetRequestedServiceQuotaChangeOutput struct { _ struct{} `type:"structure"` - // Returns the RequestedServiceQuotaChange object for the specific increase - // request. + // Information about the quota increase request. RequestedQuota *RequestedServiceQuotaChange `type:"structure"` } @@ -2553,17 +2791,17 @@ func (s *GetRequestedServiceQuotaChangeOutput) SetRequestedQuota(v *RequestedSer type GetServiceQuotaIncreaseRequestFromTemplateInput struct { _ struct{} `type:"structure"` - // Specifies the AWS Region for the quota that you want to use. + // The AWS Region. // // AwsRegion is a required field AwsRegion *string `min:"1" type:"string" required:"true"` - // Specifies the quota you want. + // The quota identifier. // // QuotaCode is a required field QuotaCode *string `min:"1" type:"string" required:"true"` - // Specifies the service that you want to use. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -2628,7 +2866,7 @@ func (s *GetServiceQuotaIncreaseRequestFromTemplateInput) SetServiceCode(v strin type GetServiceQuotaIncreaseRequestFromTemplateOutput struct { _ struct{} `type:"structure"` - // This object contains the details about the quota increase request. + // Information about the quota increase request. ServiceQuotaIncreaseRequestInTemplate *ServiceQuotaIncreaseRequestInTemplate `type:"structure"` } @@ -2651,12 +2889,12 @@ func (s *GetServiceQuotaIncreaseRequestFromTemplateOutput) SetServiceQuotaIncrea type GetServiceQuotaInput struct { _ struct{} `type:"structure"` - // Identifies the service quota you want to select. + // The quota identifier. // // QuotaCode is a required field QuotaCode *string `min:"1" type:"string" required:"true"` - // Specifies the service that you want to use. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -2709,7 +2947,7 @@ func (s *GetServiceQuotaInput) SetServiceCode(v string) *GetServiceQuotaInput { type GetServiceQuotaOutput struct { _ struct{} `type:"structure"` - // Returns the ServiceQuota object which contains all values for a quota. + // Information about the quota. Quota *ServiceQuota `type:"structure"` } @@ -2841,7 +3079,7 @@ func (s *InvalidPaginationTokenException) RequestID() string { return s.RespMetadata.RequestID } -// Invalid input was provided for the . +// The resource is in an invalid state. type InvalidResourceStateException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2900,27 +3138,15 @@ func (s *InvalidResourceStateException) RequestID() string { type ListAWSDefaultServiceQuotasInput struct { _ struct{} `type:"structure"` - // (Optional) Limits the number of results that you want to include in the response. - // If you don't include this parameter, the response defaults to a value that's - // specific to the operation. If additional items exist beyond the specified - // maximum, the NextToken element is present and has a value (isn't null). Include - // that value as the NextToken request parameter in the call to the operation - // to get the next part of the results. You should check NextToken after every - // operation to ensure that you receive all of the results. + // The maximum number of results to return with a single call. To retrieve the + // remaining results, if any, make another call with the token returned from + // this call. MaxResults *int64 `min:"1" type:"integer"` - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. - // In a subsequent call, set it to the value of the previous call's NextToken - // response to indicate where the output should continue from. If additional - // items exist beyond the specified maximum, the NextToken element is present - // and has a value (isn't null). Include that value as the NextToken request - // parameter in the call to the operation to get the next part of the results. - // You should check NextToken after every operation to ensure that you receive - // all of the results. + // The token for the next page of results. NextToken *string `type:"string"` - // Specifies the service that you want to use. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -2976,13 +3202,11 @@ func (s *ListAWSDefaultServiceQuotasInput) SetServiceCode(v string) *ListAWSDefa type ListAWSDefaultServiceQuotasOutput struct { _ struct{} `type:"structure"` - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. - // In a subsequent call, set it to the value of the previous call's NextToken - // response to indicate where the output should continue from. + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. NextToken *string `type:"string"` - // A list of the quotas in the account with the AWS default values. + // Information about the quotas. Quotas []*ServiceQuota `type:"list"` } @@ -3011,32 +3235,25 @@ func (s *ListAWSDefaultServiceQuotasOutput) SetQuotas(v []*ServiceQuota) *ListAW type ListRequestedServiceQuotaChangeHistoryByQuotaInput struct { _ struct{} `type:"structure"` - // (Optional) Limits the number of results that you want to include in the response. - // If you don't include this parameter, the response defaults to a value that's - // specific to the operation. If additional items exist beyond the specified - // maximum, the NextToken element is present and has a value (isn't null). Include - // that value as the NextToken request parameter in the call to the operation - // to get the next part of the results. You should check NextToken after every - // operation to ensure that you receive all of the results. + // The maximum number of results to return with a single call. To retrieve the + // remaining results, if any, make another call with the token returned from + // this call. MaxResults *int64 `min:"1" type:"integer"` - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. - // In a subsequent call, set it to the value of the previous call's NextToken - // response to indicate where the output should continue from. + // The token for the next page of results. NextToken *string `type:"string"` - // Specifies the service quota that you want to use + // The quota identifier. // // QuotaCode is a required field QuotaCode *string `min:"1" type:"string" required:"true"` - // Specifies the service that you want to use. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` - // Specifies the status value of the quota increase request. + // The status value of the quota increase request. Status *string `type:"string" enum:"RequestStatus"` } @@ -3108,16 +3325,11 @@ func (s *ListRequestedServiceQuotaChangeHistoryByQuotaInput) SetStatus(v string) type ListRequestedServiceQuotaChangeHistoryByQuotaOutput struct { _ struct{} `type:"structure"` - // If present in the response, this value indicates there's more output available - // that what's included in the current response. This can occur even when the - // response includes no values at all, such as when you ask for a filtered view - // of a very long list. Use this value in the NextToken request parameter in - // a subsequent call to the operation to continue processing and get the next - // part of the output. You should repeat this until the NextToken response element - // comes back empty (as null). + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. NextToken *string `type:"string"` - // Returns a list of service quota requests. + // Information about the quota increase requests. RequestedQuotas []*RequestedServiceQuotaChange `type:"list"` } @@ -3146,25 +3358,18 @@ func (s *ListRequestedServiceQuotaChangeHistoryByQuotaOutput) SetRequestedQuotas type ListRequestedServiceQuotaChangeHistoryInput struct { _ struct{} `type:"structure"` - // (Optional) Limits the number of results that you want to include in the response. - // If you don't include this parameter, the response defaults to a value that's - // specific to the operation. If additional items exist beyond the specified - // maximum, the NextToken element is present and has a value (isn't null). Include - // that value as the NextToken request parameter in the call to the operation - // to get the next part of the results. You should check NextToken after every - // operation to ensure that you receive all of the results. + // The maximum number of results to return with a single call. To retrieve the + // remaining results, if any, make another call with the token returned from + // this call. MaxResults *int64 `min:"1" type:"integer"` - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. - // In a subsequent call, set it to the value of the previous call's NextToken - // response to indicate where the output should continue from. + // The token for the next page of results. NextToken *string `type:"string"` - // Specifies the service that you want to use. + // The service identifier. ServiceCode *string `min:"1" type:"string"` - // Specifies the status value of the quota increase request. + // The status of the quota increase request. Status *string `type:"string" enum:"RequestStatus"` } @@ -3221,16 +3426,11 @@ func (s *ListRequestedServiceQuotaChangeHistoryInput) SetStatus(v string) *ListR type ListRequestedServiceQuotaChangeHistoryOutput struct { _ struct{} `type:"structure"` - // If present in the response, this value indicates there's more output available - // that what's included in the current response. This can occur even when the - // response includes no values at all, such as when you ask for a filtered view - // of a very long list. Use this value in the NextToken request parameter in - // a subsequent call to the operation to continue processing and get the next - // part of the output. You should repeat this until the NextToken response element - // comes back empty (as null). + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. NextToken *string `type:"string"` - // Returns a list of service quota requests. + // Information about the quota increase requests. RequestedQuotas []*RequestedServiceQuotaChange `type:"list"` } @@ -3259,26 +3459,18 @@ func (s *ListRequestedServiceQuotaChangeHistoryOutput) SetRequestedQuotas(v []*R type ListServiceQuotaIncreaseRequestsInTemplateInput struct { _ struct{} `type:"structure"` - // Specifies the AWS Region for the quota that you want to use. + // The AWS Region. AwsRegion *string `min:"1" type:"string"` - // (Optional) Limits the number of results that you want to include in the response. - // If you don't include this parameter, the response defaults to a value that's - // specific to the operation. If additional items exist beyond the specified - // maximum, the NextToken element is present and has a value (isn't null). Include - // that value as the NextToken request parameter in the call to the operation - // to get the next part of the results. You should check NextToken after every - // operation to ensure that you receive all of the results. + // The maximum number of results to return with a single call. To retrieve the + // remaining results, if any, make another call with the token returned from + // this call. MaxResults *int64 `min:"1" type:"integer"` - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. - // In a subsequent call, set it to the value of the previous call's NextToken - // response to indicate where the output should continue from. + // The token for the next page of results. NextToken *string `type:"string"` - // The identifier for a service. When performing an operation, use the ServiceCode - // to specify a particular service. + // The service identifier. ServiceCode *string `min:"1" type:"string"` } @@ -3338,16 +3530,11 @@ func (s *ListServiceQuotaIncreaseRequestsInTemplateInput) SetServiceCode(v strin type ListServiceQuotaIncreaseRequestsInTemplateOutput struct { _ struct{} `type:"structure"` - // If present in the response, this value indicates there's more output available - // that what's included in the current response. This can occur even when the - // response includes no values at all, such as when you ask for a filtered view - // of a very long list. Use this value in the NextToken request parameter in - // a subsequent call to the operation to continue processing and get the next - // part of the output. You should repeat this until the NextToken response element - // comes back empty (as null). + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. NextToken *string `type:"string"` - // Returns the list of values of the quota increase request in the template. + // Information about the quota increase requests. ServiceQuotaIncreaseRequestInTemplateList []*ServiceQuotaIncreaseRequestInTemplate `type:"list"` } @@ -3376,23 +3563,15 @@ func (s *ListServiceQuotaIncreaseRequestsInTemplateOutput) SetServiceQuotaIncrea type ListServiceQuotasInput struct { _ struct{} `type:"structure"` - // (Optional) Limits the number of results that you want to include in the response. - // If you don't include this parameter, the response defaults to a value that's - // specific to the operation. If additional items exist beyond the specified - // maximum, the NextToken element is present and has a value (isn't null). Include - // that value as the NextToken request parameter in the call to the operation - // to get the next part of the results. You should check NextToken after every - // operation to ensure that you receive all of the results. + // The maximum number of results to return with a single call. To retrieve the + // remaining results, if any, make another call with the token returned from + // this call. MaxResults *int64 `min:"1" type:"integer"` - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. - // In a subsequent call, set it to the value of the previous call's NextToken - // response to indicate where the output should continue from. + // The token for the next page of results. NextToken *string `type:"string"` - // The identifier for a service. When performing an operation, use the ServiceCode - // to specify a particular service. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -3448,17 +3627,11 @@ func (s *ListServiceQuotasInput) SetServiceCode(v string) *ListServiceQuotasInpu type ListServiceQuotasOutput struct { _ struct{} `type:"structure"` - // If present in the response, this value indicates there's more output available - // that what's included in the current response. This can occur even when the - // response includes no values at all, such as when you ask for a filtered view - // of a very long list. Use this value in the NextToken request parameter in - // a subsequent call to the operation to continue processing and get the next - // part of the output. You should repeat this until the NextToken response element - // comes back empty (as null). + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. NextToken *string `type:"string"` - // The response information for a quota lists all attribute information for - // the quota. + // Information about the quotas. Quotas []*ServiceQuota `type:"list"` } @@ -3487,19 +3660,12 @@ func (s *ListServiceQuotasOutput) SetQuotas(v []*ServiceQuota) *ListServiceQuota type ListServicesInput struct { _ struct{} `type:"structure"` - // (Optional) Limits the number of results that you want to include in the response. - // If you don't include this parameter, the response defaults to a value that's - // specific to the operation. If additional items exist beyond the specified - // maximum, the NextToken element is present and has a value (isn't null). Include - // that value as the NextToken request parameter in the call to the operation - // to get the next part of the results. You should check NextToken after every - // operation to ensure that you receive all of the results. + // The maximum number of results to return with a single call. To retrieve the + // remaining results, if any, make another call with the token returned from + // this call. MaxResults *int64 `min:"1" type:"integer"` - // (Optional) Use this parameter in a request if you receive a NextToken response - // in a previous request that indicates that there's more output available. - // In a subsequent call, set it to the value of the previous call's NextToken - // response to indicate where the output should continue from. + // The token for the next page of results. NextToken *string `type:"string"` } @@ -3541,16 +3707,11 @@ func (s *ListServicesInput) SetNextToken(v string) *ListServicesInput { type ListServicesOutput struct { _ struct{} `type:"structure"` - // If present in the response, this value indicates there's more output available - // that what's included in the current response. This can occur even when the - // response includes no values at all, such as when you ask for a filtered view - // of a very long list. Use this value in the NextToken request parameter in - // a subsequent call to the operation to continue processing and get the next - // part of the output. You should repeat this until the NextToken response element - // comes back empty (as null). + // The token to use to retrieve the next page of results. This value is null + // when there are no more results to return. NextToken *string `type:"string"` - // Returns a list of services. + // Information about the services. Services []*ServiceInfo `type:"list"` } @@ -3576,29 +3737,89 @@ func (s *ListServicesOutput) SetServices(v []*ServiceInfo) *ListServicesOutput { return s } -// A structure that uses CloudWatch metrics to gather data about the service -// quota. +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the applied quota for which you want to + // list tags. You can get this information by using the Service Quotas console, + // or by listing the quotas using the list-service-quotas (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) + // AWS CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) + // AWS API operation. + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput { + s.ResourceARN = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // A complex data type that contains zero or more tag elements. + Tags []*Tag `type:"list"` +} + +// String returns the string representation +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// Information about the CloudWatch metric that reflects quota usage. type MetricInfo struct { _ struct{} `type:"structure"` - // A dimension is a name/value pair that is part of the identity of a metric. - // Every metric has specific characteristics that describe it, and you can think - // of dimensions as categories for those characteristics. These dimensions are - // part of the CloudWatch Metric Identity that measures usage against a particular - // service quota. + // The metric dimension. This is a name/value pair that is part of the identity + // of a metric. MetricDimensions map[string]*string `type:"map"` - // The name of the CloudWatch metric that measures usage of a service quota. - // This is a required field. + // The name of the metric. MetricName *string `type:"string"` - // The namespace of the metric. The namespace is a container for CloudWatch - // metrics. You can specify a name for the namespace when you create a metric. + // The namespace of the metric. MetricNamespace *string `type:"string"` - // Statistics are metric data aggregations over specified periods of time. This - // is the recommended statistic to use when comparing usage in the CloudWatch - // Metric against your Service Quota. + // The metric statistic that we recommend you use when determining quota usage. MetricStatisticRecommendation *string `min:"1" type:"string"` } @@ -3748,8 +3969,7 @@ func (s *NoSuchResourceException) RequestID() string { return s.RespMetadata.RequestID } -// The organization that your account belongs to, is not in All Features mode. -// To enable all features mode, see EnableAllFeatures (https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAllFeatures.html). +// The organization that your account belongs to is not in All Features mode. type OrganizationNotInAllFeaturesModeException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -3808,22 +4028,22 @@ func (s *OrganizationNotInAllFeaturesModeException) RequestID() string { type PutServiceQuotaIncreaseRequestIntoTemplateInput struct { _ struct{} `type:"structure"` - // Specifies the AWS Region for the quota. + // The AWS Region. // // AwsRegion is a required field AwsRegion *string `min:"1" type:"string" required:"true"` - // Specifies the new, increased value for the quota. + // The new, increased value for the quota. // // DesiredValue is a required field DesiredValue *float64 `type:"double" required:"true"` - // Specifies the service quota that you want to use. + // The quota identifier. // // QuotaCode is a required field QuotaCode *string `min:"1" type:"string" required:"true"` - // Specifies the service that you want to use. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -3897,7 +4117,7 @@ func (s *PutServiceQuotaIncreaseRequestIntoTemplateInput) SetServiceCode(v strin type PutServiceQuotaIncreaseRequestIntoTemplateOutput struct { _ struct{} `type:"structure"` - // A structure that contains information about one service quota increase request. + // Information about the quota increase request. ServiceQuotaIncreaseRequestInTemplate *ServiceQuotaIncreaseRequestInTemplate `type:"structure"` } @@ -3975,14 +4195,14 @@ func (s *QuotaExceededException) RequestID() string { return s.RespMetadata.RequestID } -// A structure that contains information about the quota period. +// Information about the quota period. type QuotaPeriod struct { _ struct{} `type:"structure"` - // The time unit of a period. + // The time unit. PeriodUnit *string `type:"string" enum:"PeriodUnit"` - // The value of a period. + // The value. PeriodValue *int64 `type:"integer"` } @@ -4011,17 +4231,17 @@ func (s *QuotaPeriod) SetPeriodValue(v int64) *QuotaPeriod { type RequestServiceQuotaIncreaseInput struct { _ struct{} `type:"structure"` - // Specifies the value submitted in the service quota increase request. + // The new, increased value for the quota. // // DesiredValue is a required field DesiredValue *float64 `type:"double" required:"true"` - // Specifies the service quota that you want to use. + // The quota identifier. // // QuotaCode is a required field QuotaCode *string `min:"1" type:"string" required:"true"` - // Specifies the service that you want to use. + // The service identifier. // // ServiceCode is a required field ServiceCode *string `min:"1" type:"string" required:"true"` @@ -4083,7 +4303,7 @@ func (s *RequestServiceQuotaIncreaseInput) SetServiceCode(v string) *RequestServ type RequestServiceQuotaIncreaseOutput struct { _ struct{} `type:"structure"` - // Returns a list of service quota requests. + // Information about the quota increase request. RequestedQuota *RequestedServiceQuotaChange `type:"structure"` } @@ -4103,52 +4323,51 @@ func (s *RequestServiceQuotaIncreaseOutput) SetRequestedQuota(v *RequestedServic return s } -// A structure that contains information about a requested change for a quota. +// Information about a quota increase request. type RequestedServiceQuotaChange struct { _ struct{} `type:"structure"` - // The case Id for the service quota increase request. + // The case ID. CaseId *string `type:"string"` - // The date and time when the service quota increase request was received and - // the case Id was created. + // The date and time when the quota increase request was received and the case + // ID was created. Created *time.Time `type:"timestamp"` - // New increased value for the service quota. + // The new, increased value for the quota. DesiredValue *float64 `type:"double"` - // Identifies if the quota is global. + // Indicates whether the quota is global. GlobalQuota *bool `type:"boolean"` - // The unique identifier of a requested service quota change. + // The unique identifier. Id *string `min:"1" type:"string"` - // The date and time of the most recent change in the service quota increase - // request. + // The date and time of the most recent change. LastUpdated *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the service quota. + // The Amazon Resource Name (ARN) of the quota. QuotaArn *string `type:"string"` - // Specifies the service quota that you want to use. + // The quota identifier. QuotaCode *string `min:"1" type:"string"` - // Name of the service quota. + // The quota name. QuotaName *string `type:"string"` - // The IAM identity who submitted the service quota increase request. + // The IAM identity of the requester. Requester *string `type:"string"` - // Specifies the service that you want to use. + // The service identifier. ServiceCode *string `min:"1" type:"string"` - // The name of the AWS service specified in the increase request. + // The service name. ServiceName *string `type:"string"` - // State of the service quota increase request. + // The state of the quota increase request. Status *string `type:"string" enum:"RequestStatus"` - // Specifies the unit used for the quota. + // The unit of measurement. Unit *string `type:"string"` } @@ -4358,16 +4577,14 @@ func (s *ServiceException) RequestID() string { return s.RespMetadata.RequestID } -// A structure that contains the ServiceName and ServiceCode. It does not include -// all details of the service quota. To get those values, use the ListServiceQuotas -// operation. +// Information about a service. type ServiceInfo struct { _ struct{} `type:"structure"` - // Specifies the service that you want to use. + // The service identifier. ServiceCode *string `min:"1" type:"string"` - // The name of the AWS service specified in the increase request. + // The service name. ServiceName *string `type:"string"` } @@ -4393,45 +4610,44 @@ func (s *ServiceInfo) SetServiceName(v string) *ServiceInfo { return s } -// A structure that contains the full set of details that define the service -// quota. +// Information about a quota. type ServiceQuota struct { _ struct{} `type:"structure"` - // Specifies if the quota value can be increased. + // Indicates whether the quota value can be increased. Adjustable *bool `type:"boolean"` - // Specifies the ErrorCode and ErrorMessage when success isn't achieved. + // The error code and error reason. ErrorReason *ErrorReason `type:"structure"` - // Specifies if the quota is global. + // Indicates whether the quota is global. GlobalQuota *bool `type:"boolean"` - // Identifies the unit and value of how time is measured. + // The period of time. Period *QuotaPeriod `type:"structure"` - // The Amazon Resource Name (ARN) of the service quota. + // The Amazon Resource Name (ARN) of the quota. QuotaArn *string `type:"string"` - // The code identifier for the service quota specified. + // The quota identifier. QuotaCode *string `min:"1" type:"string"` - // The name identifier of the service quota. + // The quota name. QuotaName *string `type:"string"` - // Specifies the service that you want to use. + // The service identifier. ServiceCode *string `min:"1" type:"string"` - // The name of the AWS service specified in the increase request. + // The service name. ServiceName *string `type:"string"` - // The unit of measurement for the value of the service quota. + // The unit of measurement. Unit *string `type:"string"` - // Specifies the details about the measurement. + // Information about the measurement. UsageMetric *MetricInfo `type:"structure"` - // The value of service quota. + // The quota value. Value *float64 `type:"double"` } @@ -4517,33 +4733,32 @@ func (s *ServiceQuota) SetValue(v float64) *ServiceQuota { return s } -// A structure that contains information about one service quota increase request. +// Information about a quota increase request. type ServiceQuotaIncreaseRequestInTemplate struct { _ struct{} `type:"structure"` - // The AWS Region where the increase request occurs. + // The AWS Region. AwsRegion *string `min:"1" type:"string"` - // Identifies the new, increased value of the service quota in the increase - // request. + // The new, increased value of the quota. DesiredValue *float64 `type:"double"` - // Specifies if the quota is a global quota. + // Indicates whether the quota is global. GlobalQuota *bool `type:"boolean"` - // The code identifier for the service quota specified in the increase request. + // The quota identifier. QuotaCode *string `min:"1" type:"string"` - // The name of the service quota in the increase request. + // The quota name. QuotaName *string `type:"string"` - // The code identifier for the AWS service specified in the increase request. + // The service identifier. ServiceCode *string `min:"1" type:"string"` - // The name of the AWS service specified in the increase request. + // The service name. ServiceName *string `type:"string"` - // The unit of measure for the increase request. + // The unit of measurement. Unit *string `type:"string"` } @@ -4606,8 +4821,6 @@ func (s *ServiceQuotaIncreaseRequestInTemplate) SetUnit(v string) *ServiceQuotaI } // The quota request template is not associated with your organization. -// -// To use the template, call AssociateServiceQuotaTemplate. type ServiceQuotaTemplateNotInUseException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4663,8 +4876,209 @@ func (s *ServiceQuotaTemplateNotInUseException) RequestID() string { return s.RespMetadata.RequestID } -// The Service Quotas template is not available in the Region where you are -// making the request. Please make the request in us-east-1. +// A complex data type that contains a tag key and tag value. +type Tag struct { + _ struct{} `type:"structure"` + + // A string that contains a tag key. The string length should be between 1 and + // 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special + // characters _ - . : / = + @. + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true"` + + // A string that contains an optional tag value. The string length should be + // between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, + // and the special characters _ - . : / = + @. + // + // Value is a required field + Value *string `type:"string" required:"true"` +} + +// String returns the string representation +func (s Tag) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Tag) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Tag) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Tag"} + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *Tag) SetKey(v string) *Tag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Tag) SetValue(v string) *Tag { + s.Value = &v + return s +} + +// The specified tag is a reserved word and cannot be used. +type TagPolicyViolationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation +func (s TagPolicyViolationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagPolicyViolationException) GoString() string { + return s.String() +} + +func newErrorTagPolicyViolationException(v protocol.ResponseMetadata) error { + return &TagPolicyViolationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *TagPolicyViolationException) Code() string { + return "TagPolicyViolationException" +} + +// Message returns the exception's message. +func (s *TagPolicyViolationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *TagPolicyViolationException) OrigErr() error { + return nil +} + +func (s *TagPolicyViolationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *TagPolicyViolationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *TagPolicyViolationException) RequestID() string { + return s.RespMetadata.RequestID +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the applied quota. You can get this information + // by using the Service Quotas console, or by listing the quotas using the list-service-quotas + // (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) + // AWS CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) + // AWS API operation. + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` + + // The tags that you want to add to the resource. + // + // Tags is a required field + Tags []*Tag `min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput { + s.ResourceARN = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// The Service Quotas template is not available in this AWS Region. type TemplatesNotAvailableInRegionException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4777,6 +5191,137 @@ func (s *TooManyRequestsException) RequestID() string { return s.RespMetadata.RequestID } +// You've exceeded the number of tags allowed for a resource. For more information, +// see Tag restrictions (https://docs.aws.amazon.com/servicequotas/latest/userguide/sq-tagging.html#sq-tagging-restrictions) +// in the Service Quotas User Guide. +type TooManyTagsException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation +func (s TooManyTagsException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TooManyTagsException) GoString() string { + return s.String() +} + +func newErrorTooManyTagsException(v protocol.ResponseMetadata) error { + return &TooManyTagsException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *TooManyTagsException) Code() string { + return "TooManyTagsException" +} + +// Message returns the exception's message. +func (s *TooManyTagsException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *TooManyTagsException) OrigErr() error { + return nil +} + +func (s *TooManyTagsException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *TooManyTagsException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *TooManyTagsException) RequestID() string { + return s.RespMetadata.RequestID +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the applied quota that you want to untag. + // You can get this information by using the Service Quotas console, or by listing + // the quotas using the list-service-quotas (https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html) + // AWS CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) + // AWS API operation. + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` + + // The keys of the tags that you want to remove from the resource. + // + // TagKeys is a required field + TagKeys []*string `type:"list" required:"true"` +} + +// String returns the string representation +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput { + s.ResourceARN = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + const ( // ErrorCodeDependencyAccessDeniedError is a ErrorCode enum value ErrorCodeDependencyAccessDeniedError = "DEPENDENCY_ACCESS_DENIED_ERROR" diff --git a/service/servicequotas/doc.go b/service/servicequotas/doc.go index 3f952b88279..f321ac7c849 100644 --- a/service/servicequotas/doc.go +++ b/service/servicequotas/doc.go @@ -3,19 +3,10 @@ // Package servicequotas provides the client and types for making API // requests to Service Quotas. // -// Service Quotas is a web service that you can use to manage many of your AWS -// service quotas. Quotas, also referred to as limits, are the maximum values -// for a resource, item, or operation. This guide provide descriptions of the -// Service Quotas actions that you can call from an API. For the Service Quotas -// user guide, which explains how to use Service Quotas from the console, see -// What is Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html). -// -// AWS provides SDKs that consist of libraries and sample code for programming -// languages and platforms (Java, Ruby, .NET, iOS, Android, etc...,). The SDKs -// provide a convenient way to create programmatic access to Service Quotas -// and AWS. For information about the AWS SDKs, including how to download and -// install them, see the Tools for Amazon Web Services (https://docs.aws.amazon.com/aws.amazon.com/tools) -// page. +// With Service Quotas, you can view and manage your quotas easily as your AWS +// workloads grow. Quotas, also referred to as limits, are the maximum number +// of resources that you can create in your AWS account. For more information, +// see the Service Quotas User Guide (https://docs.aws.amazon.com/servicequotas/latest/userguide/). // // See https://docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24 for more information on this service. // diff --git a/service/servicequotas/errors.go b/service/servicequotas/errors.go index 664f268e1e9..2b5be212050 100644 --- a/service/servicequotas/errors.go +++ b/service/servicequotas/errors.go @@ -12,13 +12,13 @@ const ( // "AWSServiceAccessNotEnabledException". // // The action you attempted is not allowed unless Service Access with Service - // Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate. + // Quotas is enabled in your organization. ErrCodeAWSServiceAccessNotEnabledException = "AWSServiceAccessNotEnabledException" // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // - // You do not have sufficient access to perform this action. + // You do not have sufficient permission to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeDependencyAccessDeniedException for service response error code @@ -42,7 +42,7 @@ const ( // ErrCodeInvalidResourceStateException for service response error code // "InvalidResourceStateException". // - // Invalid input was provided for the . + // The resource is in an invalid state. ErrCodeInvalidResourceStateException = "InvalidResourceStateException" // ErrCodeNoAvailableOrganizationException for service response error code @@ -60,8 +60,7 @@ const ( // ErrCodeOrganizationNotInAllFeaturesModeException for service response error code // "OrganizationNotInAllFeaturesModeException". // - // The organization that your account belongs to, is not in All Features mode. - // To enable all features mode, see EnableAllFeatures (https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAllFeatures.html). + // The organization that your account belongs to is not in All Features mode. ErrCodeOrganizationNotInAllFeaturesModeException = "OrganizationNotInAllFeaturesModeException" // ErrCodeQuotaExceededException for service response error code @@ -88,15 +87,18 @@ const ( // "ServiceQuotaTemplateNotInUseException". // // The quota request template is not associated with your organization. - // - // To use the template, call AssociateServiceQuotaTemplate. ErrCodeServiceQuotaTemplateNotInUseException = "ServiceQuotaTemplateNotInUseException" + // ErrCodeTagPolicyViolationException for service response error code + // "TagPolicyViolationException". + // + // The specified tag is a reserved word and cannot be used. + ErrCodeTagPolicyViolationException = "TagPolicyViolationException" + // ErrCodeTemplatesNotAvailableInRegionException for service response error code // "TemplatesNotAvailableInRegionException". // - // The Service Quotas template is not available in the Region where you are - // making the request. Please make the request in us-east-1. + // The Service Quotas template is not available in this AWS Region. ErrCodeTemplatesNotAvailableInRegionException = "TemplatesNotAvailableInRegionException" // ErrCodeTooManyRequestsException for service response error code @@ -105,6 +107,14 @@ const ( // Due to throttling, the request was denied. Slow down the rate of request // calls, or request an increase for this quota. ErrCodeTooManyRequestsException = "TooManyRequestsException" + + // ErrCodeTooManyTagsException for service response error code + // "TooManyTagsException". + // + // You've exceeded the number of tags allowed for a resource. For more information, + // see Tag restrictions (https://docs.aws.amazon.com/servicequotas/latest/userguide/sq-tagging.html#sq-tagging-restrictions) + // in the Service Quotas User Guide. + ErrCodeTooManyTagsException = "TooManyTagsException" ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ @@ -121,6 +131,8 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "ResourceAlreadyExistsException": newErrorResourceAlreadyExistsException, "ServiceException": newErrorServiceException, "ServiceQuotaTemplateNotInUseException": newErrorServiceQuotaTemplateNotInUseException, + "TagPolicyViolationException": newErrorTagPolicyViolationException, "TemplatesNotAvailableInRegionException": newErrorTemplatesNotAvailableInRegionException, "TooManyRequestsException": newErrorTooManyRequestsException, + "TooManyTagsException": newErrorTooManyTagsException, } diff --git a/service/servicequotas/servicequotasiface/interface.go b/service/servicequotas/servicequotasiface/interface.go index ec39f754ffd..bd1e5fcb15c 100644 --- a/service/servicequotas/servicequotasiface/interface.go +++ b/service/servicequotas/servicequotasiface/interface.go @@ -134,6 +134,10 @@ type ServiceQuotasAPI interface { ListServicesPages(*servicequotas.ListServicesInput, func(*servicequotas.ListServicesOutput, bool) bool) error ListServicesPagesWithContext(aws.Context, *servicequotas.ListServicesInput, func(*servicequotas.ListServicesOutput, bool) bool, ...request.Option) error + ListTagsForResource(*servicequotas.ListTagsForResourceInput) (*servicequotas.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *servicequotas.ListTagsForResourceInput, ...request.Option) (*servicequotas.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*servicequotas.ListTagsForResourceInput) (*request.Request, *servicequotas.ListTagsForResourceOutput) + PutServiceQuotaIncreaseRequestIntoTemplate(*servicequotas.PutServiceQuotaIncreaseRequestIntoTemplateInput) (*servicequotas.PutServiceQuotaIncreaseRequestIntoTemplateOutput, error) PutServiceQuotaIncreaseRequestIntoTemplateWithContext(aws.Context, *servicequotas.PutServiceQuotaIncreaseRequestIntoTemplateInput, ...request.Option) (*servicequotas.PutServiceQuotaIncreaseRequestIntoTemplateOutput, error) PutServiceQuotaIncreaseRequestIntoTemplateRequest(*servicequotas.PutServiceQuotaIncreaseRequestIntoTemplateInput) (*request.Request, *servicequotas.PutServiceQuotaIncreaseRequestIntoTemplateOutput) @@ -141,6 +145,14 @@ type ServiceQuotasAPI interface { RequestServiceQuotaIncrease(*servicequotas.RequestServiceQuotaIncreaseInput) (*servicequotas.RequestServiceQuotaIncreaseOutput, error) RequestServiceQuotaIncreaseWithContext(aws.Context, *servicequotas.RequestServiceQuotaIncreaseInput, ...request.Option) (*servicequotas.RequestServiceQuotaIncreaseOutput, error) RequestServiceQuotaIncreaseRequest(*servicequotas.RequestServiceQuotaIncreaseInput) (*request.Request, *servicequotas.RequestServiceQuotaIncreaseOutput) + + TagResource(*servicequotas.TagResourceInput) (*servicequotas.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *servicequotas.TagResourceInput, ...request.Option) (*servicequotas.TagResourceOutput, error) + TagResourceRequest(*servicequotas.TagResourceInput) (*request.Request, *servicequotas.TagResourceOutput) + + UntagResource(*servicequotas.UntagResourceInput) (*servicequotas.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *servicequotas.UntagResourceInput, ...request.Option) (*servicequotas.UntagResourceOutput, error) + UntagResourceRequest(*servicequotas.UntagResourceInput) (*request.Request, *servicequotas.UntagResourceOutput) } var _ ServiceQuotasAPI = (*servicequotas.ServiceQuotas)(nil)