From af5b5fe4a24f207066b36e72205884742fdaccf3 Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Tue, 4 Jun 2019 18:24:28 +0000 Subject: [PATCH 1/3] Update to latest models --- .../next-release/api-change-ec2-91509.json | 5 + .../api-change-elasticache-42182.json | 5 + .changes/next-release/api-change-iam-45.json | 5 + .../next-release/api-change-s3-15004.json | 5 + .../api-change-storagegateway-89542.json | 5 + botocore/data/ec2/2016-11-15/service-2.json | 56 +- .../elasticache/2015-02-02/paginators-1.json | 12 + .../elasticache/2015-02-02/service-2.json | 665 ++++++++++++++++-- botocore/data/iam/2010-05-08/service-2.json | 4 +- botocore/data/s3/2006-03-01/service-2.json | 373 +++++----- .../storagegateway/2013-06-30/service-2.json | 50 ++ 11 files changed, 951 insertions(+), 234 deletions(-) create mode 100644 .changes/next-release/api-change-ec2-91509.json create mode 100644 .changes/next-release/api-change-elasticache-42182.json create mode 100644 .changes/next-release/api-change-iam-45.json create mode 100644 .changes/next-release/api-change-s3-15004.json create mode 100644 .changes/next-release/api-change-storagegateway-89542.json diff --git a/.changes/next-release/api-change-ec2-91509.json b/.changes/next-release/api-change-ec2-91509.json new file mode 100644 index 0000000000..c936aeaa44 --- /dev/null +++ b/.changes/next-release/api-change-ec2-91509.json @@ -0,0 +1,5 @@ +{ + "category": "``ec2``", + "type": "api-change", + "description": "Update ec2 client to latest version" +} diff --git a/.changes/next-release/api-change-elasticache-42182.json b/.changes/next-release/api-change-elasticache-42182.json new file mode 100644 index 0000000000..54225ca06f --- /dev/null +++ b/.changes/next-release/api-change-elasticache-42182.json @@ -0,0 +1,5 @@ +{ + "category": "``elasticache``", + "type": "api-change", + "description": "Update elasticache client to latest version" +} diff --git a/.changes/next-release/api-change-iam-45.json b/.changes/next-release/api-change-iam-45.json new file mode 100644 index 0000000000..e66d971cb7 --- /dev/null +++ b/.changes/next-release/api-change-iam-45.json @@ -0,0 +1,5 @@ +{ + "category": "``iam``", + "type": "api-change", + "description": "Update iam client to latest version" +} diff --git a/.changes/next-release/api-change-s3-15004.json b/.changes/next-release/api-change-s3-15004.json new file mode 100644 index 0000000000..0f386d16c8 --- /dev/null +++ b/.changes/next-release/api-change-s3-15004.json @@ -0,0 +1,5 @@ +{ + "category": "``s3``", + "type": "api-change", + "description": "Update s3 client to latest version" +} diff --git a/.changes/next-release/api-change-storagegateway-89542.json b/.changes/next-release/api-change-storagegateway-89542.json new file mode 100644 index 0000000000..b1660a7026 --- /dev/null +++ b/.changes/next-release/api-change-storagegateway-89542.json @@ -0,0 +1,5 @@ +{ + "category": "``storagegateway``", + "type": "api-change", + "description": "Update storagegateway client to latest version" +} diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 8f616b16b1..2f32a87e47 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -2342,7 +2342,7 @@ }, "input":{"shape":"EnableEbsEncryptionByDefaultRequest"}, "output":{"shape":"EnableEbsEncryptionByDefaultResult"}, - "documentation":"

Enables default encryption for EBS volumes that are created in your account in the current region.

Once encryption is enabled with this action, EBS volumes that are created in your account will always be encrypted even if encryption is not specified at launch. This setting overrides the encrypted setting to true in all API calls that create EBS volumes in your account. A volume will be encrypted even if you specify encryption to be false in the API call that creates the volume.

If you do not specify a customer master key (CMK) in the API call that creates the EBS volume, then the volume is encrypted to your AWS account's default CMK.

You can specify a default CMK of your choice using ModifyEbsDefaultKmsKeyId.

Enabling default encryption for EBS volumes has no effect on existing unencrypted volumes in your account. Encrypting the data in these requires manual action. You can either create an encrypted snapshot of an unencrypted volume, or encrypt a copy of an unencrypted snapshot. Any volume restored from an encrypted snapshot is also encrypted. For more information, see Amazon EBS Snapshots.

After EBS encryption by default is enabled, you can no longer launch older-generation instance types that do not support encryption. For more information, see Supported Instance Types.

" + "documentation":"

Enables default encryption for EBS volumes that are created in your account in the current region.

Once encryption is enabled with this action, EBS volumes that are created in your account will always be encrypted even if encryption is not specified at launch. This setting overrides the encrypted setting to true in all API calls that create EBS volumes in your account. A volume will be encrypted even if you specify encryption to be false in the API call that creates the volume.

If you do not specify a customer master key (CMK) in the API call that creates the EBS volume, then the volume is encrypted to your AWS account's managed CMK.

You can specify a CMK of your choice using ModifyEbsDefaultKmsKeyId.

Enabling encryption-by-default for EBS volumes has no effect on existing unencrypted volumes in your account. Encrypting the data in these requires manual action. You can either create an encrypted snapshot of an unencrypted volume, or encrypt a copy of an unencrypted snapshot. Any volume restored from an encrypted snapshot is also encrypted. For more information, see Amazon EBS Snapshots.

After EBS encryption-by-default is enabled, you can no longer launch older-generation instance types that do not support encryption. For more information, see Supported Instance Types.

" }, "EnableTransitGatewayRouteTablePropagation":{ "name":"EnableTransitGatewayRouteTablePropagation", @@ -2620,7 +2620,7 @@ }, "input":{"shape":"ModifyEbsDefaultKmsKeyIdRequest"}, "output":{"shape":"ModifyEbsDefaultKmsKeyIdResult"}, - "documentation":"

Changes the default customer master key (CMK) that your account uses to encrypt EBS volumes if you don't specify a CMK in the API call.

Your account has an AWS-managed default CMK that is used for encrypting an EBS volume when no CMK is specified in the API call that creates the volume. By calling this API, you can specify a customer-managed CMK to use in place of the AWS-managed default CMK.

Note: Deleting or disabling the custom CMK that you have specified to act as your default CMK will result in instance-launch failures.

" + "documentation":"

Changes the customer master key (CMK) that your account uses to encrypt EBS volumes if you don't specify a CMK in the API call.

By default, your account has an AWS-managed CMK that is used for encrypting an EBS volume when no CMK is specified in the API call that creates the volume. By calling this API, you can specify a customer-managed CMK to use in place of the AWS-managed CMK.

Note: Deleting or disabling the CMK that you have specified to act as your default CMK will result in instance-launch failures.

" }, "ModifyFleet":{ "name":"ModifyFleet", @@ -3704,7 +3704,7 @@ }, "ClientToken":{ "shape":"String", - "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", "locationName":"clientToken" }, "InstanceType":{ @@ -3721,6 +3721,10 @@ "shape":"TagSpecificationList", "documentation":"

The tags to apply to the Dedicated Host during creation.

", "locationName":"TagSpecification" + }, + "HostRecovery":{ + "shape":"HostRecovery", + "documentation":"

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.

Default: off

" } } }, @@ -3749,7 +3753,8 @@ "under-assessment", "permanent-failure", "released", - "released-permanent-failure" + "released-permanent-failure", + "pending" ] }, "AllocationStrategy":{ @@ -6346,7 +6351,7 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

", + "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the volume. This parameter is only required if you want to use a customer-managed CMK; if this parameter is not specified, your AWS-managed CMK for the account is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

AWS authenticates KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

", "locationName":"kmsKeyId" }, "PresignedUrl":{ @@ -7023,7 +7028,7 @@ "members":{ "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", - "documentation":"

Tthe block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

", + "documentation":"

The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

", "locationName":"blockDeviceMapping" }, "Description":{ @@ -8018,7 +8023,7 @@ }, "Encrypted":{ "shape":"Boolean", - "documentation":"

Specifies the encryption state of the volume. The default effect of setting the Encrypted parameter to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether account-level encryption is enabled. Each default case can be overridden by specifying a customer master key (CMK) using the KmsKeyId parameter, in addition to setting Encrypted to true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

", + "documentation":"

Specifies the encryption state of the volume. The default effect of setting the Encrypted parameter to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether account-level encryption is enabled. Each default case can be overridden by specifying a customer master key (CMK) using the KmsKeyId parameter, in addition to setting Encrypted to true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

", "locationName":"encrypted" }, "Iops":{ @@ -8027,7 +8032,7 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

" + "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the volume. This parameter is only required if you want to use a customer-managed CMK; if this parameter is not specified, your AWS-managed CMK for the account is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

AWS authenticates KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

" }, "Size":{ "shape":"Integer", @@ -10655,12 +10660,12 @@ }, "MaxResults":{ "shape":"Integer", - "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", - "documentation":"

The token to retrieve the next page of results.

", + "documentation":"

The token to use to retrieve the next page of results.

", "locationName":"nextToken" } } @@ -16082,7 +16087,7 @@ }, "ClientToken":{ "shape":"String", - "documentation":"

Unique, case-sensitive identifier that you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", "locationName":"clientToken" }, "HostId":{ @@ -16124,6 +16129,11 @@ "shape":"TagList", "documentation":"

Any tags assigned to the Dedicated Host.

", "locationName":"tagSet" + }, + "HostRecovery":{ + "shape":"HostRecovery", + "documentation":"

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

", + "locationName":"hostRecovery" } }, "documentation":"

Describes the properties of the Dedicated Host.

" @@ -16232,6 +16242,13 @@ }, "documentation":"

Describes properties of a Dedicated Host.

" }, + "HostRecovery":{ + "type":"string", + "enum":[ + "on", + "off" + ] + }, "HostReservation":{ "type":"structure", "members":{ @@ -20146,7 +20163,7 @@ "members":{ "KmsKeyId":{ "shape":"String", - "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

" + "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the volume. This parameter is only required if you want to use a customer-managed CMK; if this parameter is not specified, your AWS-managed CMK for the account is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

AWS authenticates KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.

" }, "DryRun":{ "shape":"Boolean", @@ -20260,10 +20277,7 @@ }, "ModifyHostsRequest":{ "type":"structure", - "required":[ - "AutoPlacement", - "HostIds" - ], + "required":["HostIds"], "members":{ "AutoPlacement":{ "shape":"AutoPlacement", @@ -20274,6 +20288,10 @@ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated Hosts to modify.

", "locationName":"hostId" + }, + "HostRecovery":{ + "shape":"HostRecovery", + "documentation":"

Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.

" } } }, @@ -22713,7 +22731,7 @@ "members":{ "ClientToken":{ "shape":"String", - "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", @@ -22738,7 +22756,7 @@ "members":{ "ClientToken":{ "shape":"String", - "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", "locationName":"clientToken" }, "CurrencyCode":{ @@ -25068,7 +25086,7 @@ "members":{ "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", - "documentation":"

The block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.

", + "documentation":"

The block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "ImageId":{ diff --git a/botocore/data/elasticache/2015-02-02/paginators-1.json b/botocore/data/elasticache/2015-02-02/paginators-1.json index 8724740d6f..9ee5996e11 100644 --- a/botocore/data/elasticache/2015-02-02/paginators-1.json +++ b/botocore/data/elasticache/2015-02-02/paginators-1.json @@ -71,6 +71,18 @@ "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Snapshots" + }, + "DescribeServiceUpdates": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ServiceUpdates" + }, + "DescribeUpdateActions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "UpdateActions" } } } diff --git a/botocore/data/elasticache/2015-02-02/service-2.json b/botocore/data/elasticache/2015-02-02/service-2.json index d3f5f846a3..80fbd53d52 100644 --- a/botocore/data/elasticache/2015-02-02/service-2.json +++ b/botocore/data/elasticache/2015-02-02/service-2.json @@ -28,7 +28,7 @@ {"shape":"TagQuotaPerResourceExceeded"}, {"shape":"InvalidARNFault"} ], - "documentation":"

Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.

When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

" + "documentation":"

Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.

When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

" }, "AuthorizeCacheSecurityGroupIngress":{ "name":"AuthorizeCacheSecurityGroupIngress", @@ -50,6 +50,40 @@ ], "documentation":"

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

" }, + "BatchApplyUpdateAction":{ + "name":"BatchApplyUpdateAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchApplyUpdateActionMessage"}, + "output":{ + "shape":"UpdateActionResultsMessage", + "resultWrapper":"BatchApplyUpdateActionResult" + }, + "errors":[ + {"shape":"ServiceUpdateNotFoundFault"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

" + }, + "BatchStopUpdateAction":{ + "name":"BatchStopUpdateAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchStopUpdateActionMessage"}, + "output":{ + "shape":"UpdateActionResultsMessage", + "resultWrapper":"BatchStopUpdateActionResult" + }, + "errors":[ + {"shape":"ServiceUpdateNotFoundFault"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

" + }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ @@ -69,7 +103,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Makes a copy of an existing snapshot.

This operation is valid for Redis only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

You could receive the following error messages.

Error Messages

" + "documentation":"

Makes a copy of an existing snapshot.

This operation is valid for Redis only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

You could receive the following error messages.

Error Messages

" }, "CreateCacheCluster":{ "name":"CreateCacheCluster", @@ -118,7 +152,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

" + "documentation":"

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

" }, "CreateCacheSecurityGroup":{ "name":"CreateCacheSecurityGroup", @@ -137,7 +171,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

" + "documentation":"

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

" }, "CreateCacheSubnetGroup":{ "name":"CreateCacheSubnetGroup", @@ -186,7 +220,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.

This operation is valid for Redis only.

" + "documentation":"

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.

This operation is valid for Redis only.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", @@ -259,7 +293,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group.

This operation is not valid for Redis (cluster mode enabled) clusters.

" + "documentation":"

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

" }, "DeleteCacheParameterGroup":{ "name":"DeleteCacheParameterGroup", @@ -428,7 +462,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.

" + "documentation":"

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

" }, "DescribeCacheSubnetGroups":{ "name":"DescribeCacheSubnetGroups", @@ -444,7 +478,7 @@ "errors":[ {"shape":"CacheSubnetGroupNotFoundFault"} ], - "documentation":"

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

" + "documentation":"

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

" }, "DescribeEngineDefaultParameters":{ "name":"DescribeEngineDefaultParameters", @@ -534,6 +568,24 @@ ], "documentation":"

Lists available reserved cache node offerings.

" }, + "DescribeServiceUpdates":{ + "name":"DescribeServiceUpdates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceUpdatesMessage"}, + "output":{ + "shape":"ServiceUpdatesMessage", + "resultWrapper":"DescribeServiceUpdatesResult" + }, + "errors":[ + {"shape":"ServiceUpdateNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns details of the service updates

" + }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ @@ -553,6 +605,23 @@ ], "documentation":"

Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

This operation is valid for Redis only.

" }, + "DescribeUpdateActions":{ + "name":"DescribeUpdateActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUpdateActionsMessage"}, + "output":{ + "shape":"UpdateActionsMessage", + "resultWrapper":"DescribeUpdateActionsResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns details of the update actions

" + }, "IncreaseReplicaCount":{ "name":"IncreaseReplicaCount", "http":{ @@ -614,7 +683,7 @@ {"shape":"SnapshotNotFoundFault"}, {"shape":"InvalidARNFault"} ], - "documentation":"

Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

If the cluster is not in the available state, ListTagsForResource returns an error.

You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.

" + "documentation":"

Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

If the cluster is not in the available state, ListTagsForResource returns an error.

You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.

" }, "ModifyCacheCluster":{ "name":"ModifyCacheCluster", @@ -706,7 +775,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Modifies the settings for a replication group.

For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see:

This operation is valid for Redis only.

" + "documentation":"

Modifies the settings for a replication group.

For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see:

This operation is valid for Redis only.

" }, "ModifyReplicationGroupShardConfiguration":{ "name":"ModifyReplicationGroupShardConfiguration", @@ -848,7 +917,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.

" + "documentation":"

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.

" } }, "shapes":{ @@ -880,7 +949,7 @@ "members":{ "ResourceName":{ "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "documentation":"

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" }, "Tags":{ "shape":"TagList", @@ -986,6 +1055,40 @@ } }, "AwsQueryErrorMessage":{"type":"string"}, + "BatchApplyUpdateActionMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupIds", + "ServiceUpdateName" + ], + "members":{ + "ReplicationGroupIds":{ + "shape":"ReplicationGroupIdList", + "documentation":"

The replication group IDs

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + } + } + }, + "BatchStopUpdateActionMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupIds", + "ServiceUpdateName" + ], + "members":{ + "ReplicationGroupIds":{ + "shape":"ReplicationGroupIdList", + "documentation":"

The replication group IDs

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + } + } + }, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "CacheCluster":{ @@ -1005,7 +1108,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The name of the compute and memory capacity node type for the cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The name of the compute and memory capacity node type for the cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "Engine":{ "shape":"String", @@ -1150,7 +1253,7 @@ }, "CacheParameterGroupFamily":{ "shape":"String", - "documentation":"

The name of the cache parameter group family associated with this cache engine.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0

" + "documentation":"

The name of the cache parameter group family associated with this cache engine.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" }, "CacheEngineDescription":{ "shape":"String", @@ -1216,7 +1319,7 @@ "documentation":"

The Availability Zone where this node was created and now resides.

" } }, - "documentation":"

Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "CacheNodeIdsList":{ "type":"list", @@ -1269,7 +1372,7 @@ }, "ChangeType":{ "shape":"ChangeType", - "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" + "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" } }, "documentation":"

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

" @@ -1311,7 +1414,7 @@ }, "CacheParameterGroupFamily":{ "shape":"String", - "documentation":"

The name of the cache parameter group family that this cache parameter group is compatible with.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0

" + "documentation":"

The name of the cache parameter group family that this cache parameter group is compatible with.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" }, "Description":{ "shape":"String", @@ -1671,7 +1774,7 @@ "members":{ "NodeGroupId":{ "shape":"AllowedNodeGroupId", - "documentation":"

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

" + "documentation":"

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

" }, "NewReplicaCount":{ "shape":"Integer", @@ -1701,7 +1804,7 @@ }, "TargetBucket":{ "shape":"String", - "documentation":"

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

" + "documentation":"

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

" } }, "documentation":"

Represents the input of a CopySnapshotMessage operation.

" @@ -1742,7 +1845,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "Engine":{ "shape":"String", @@ -1750,7 +1853,7 @@ }, "EngineVersion":{ "shape":"String", - "documentation":"

The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

" + "documentation":"

The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

" }, "CacheParameterGroupName":{ "shape":"String", @@ -1758,7 +1861,7 @@ }, "CacheSubnetGroupName":{ "shape":"String", - "documentation":"

The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" + "documentation":"

The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", @@ -1831,7 +1934,7 @@ }, "CacheParameterGroupFamily":{ "shape":"String", - "documentation":"

The name of the cache parameter group family that the cache parameter group can be used with.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0

" + "documentation":"

The name of the cache parameter group family that the cache parameter group can be used with.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" }, "Description":{ "shape":"String", @@ -1920,7 +2023,7 @@ }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", - "documentation":"

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" + "documentation":"

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" }, "NumCacheClusters":{ "shape":"IntegerOptional", @@ -1944,7 +2047,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "Engine":{ "shape":"String", @@ -1952,15 +2055,15 @@ }, "EngineVersion":{ "shape":"String", - "documentation":"

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

" + "documentation":"

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

" }, "CacheParameterGroupName":{ "shape":"String", - "documentation":"

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

" + "documentation":"

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

" }, "CacheSubnetGroupName":{ "shape":"String", - "documentation":"

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" + "documentation":"

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", @@ -1972,7 +2075,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"

A list of cost allocation tags to be added to this resource. A tag is a key-value pair.

" + "documentation":"

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

" }, "SnapshotArns":{ "shape":"SnapshotArnsList", @@ -2077,7 +2180,7 @@ }, "ApplyImmediately":{ "shape":"Boolean", - "documentation":"

If True, the number of replica nodes is decreased immediately. If False, the number of replica nodes is decreased during the next maintenance window.

" + "documentation":"

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

" } } }, @@ -2222,7 +2325,7 @@ }, "CacheParameterGroupFamily":{ "shape":"String", - "documentation":"

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0

Constraints:

" + "documentation":"

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

" }, "MaxRecords":{ "shape":"IntegerOptional", @@ -2322,7 +2425,7 @@ "members":{ "CacheParameterGroupFamily":{ "shape":"String", - "documentation":"

The name of the cache parameter group family.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0

" + "documentation":"

The name of the cache parameter group family.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" }, "MaxRecords":{ "shape":"IntegerOptional", @@ -2406,7 +2509,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "Duration":{ "shape":"String", @@ -2440,7 +2543,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "Duration":{ "shape":"String", @@ -2465,6 +2568,27 @@ }, "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" }, + "DescribeServiceUpdatesMessage":{ + "type":"structure", + "members":{ + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatusList", + "documentation":"

The status of the service update

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, "DescribeSnapshotsListMessage":{ "type":"structure", "members":{ @@ -2513,6 +2637,43 @@ }, "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" }, + "DescribeUpdateActionsMessage":{ + "type":"structure", + "members":{ + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ReplicationGroupIds":{ + "shape":"ReplicationGroupIdList", + "documentation":"

The replication group IDs

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatusList", + "documentation":"

The status of the service update

" + }, + "ServiceUpdateTimeRange":{ + "shape":"TimeRangeFilter", + "documentation":"

The range of time specified to search for service updates that are in available status

" + }, + "UpdateActionStatus":{ + "shape":"UpdateActionStatusList", + "documentation":"

The status of the update action.

" + }, + "ShowNodeLevelUpdateStatus":{ + "shape":"BooleanOptional", + "documentation":"

Dictates whether to include node level update status in the response

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, "Double":{"type":"double"}, "EC2SecurityGroup":{ "type":"structure", @@ -2558,7 +2719,7 @@ "members":{ "CacheParameterGroupFamily":{ "shape":"String", - "documentation":"

Specifies the name of the cache parameter group family to which the engine default parameters apply.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2 | redis4.0

" + "documentation":"

Specifies the name of the cache parameter group family to which the engine default parameters apply.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" }, "Marker":{ "shape":"String", @@ -2640,7 +2801,7 @@ }, "ApplyImmediately":{ "shape":"Boolean", - "documentation":"

If True, the number of replica nodes is increased immediately. If False, the number of replica nodes is increased during the next maintenance window.

" + "documentation":"

If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

" } } }, @@ -2654,7 +2815,7 @@ "type":"structure", "members":{ }, - "documentation":"

The requested cache node type is not available in the specified Availability Zone.

", + "documentation":"

The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

", "error":{ "code":"InsufficientCacheClusterCapacity", "httpStatusCode":400, @@ -2818,7 +2979,7 @@ "members":{ "ResourceName":{ "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } }, "documentation":"

The input parameters for the ListTagsForResource operation.

" @@ -2841,11 +3002,11 @@ }, "AZMode":{ "shape":"AZMode", - "documentation":"

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

" + "documentation":"

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

" }, "NewAvailabilityZones":{ "shape":"PreferredAvailabilityZoneList", - "documentation":"

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

" + "documentation":"

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", @@ -2877,7 +3038,7 @@ }, "EngineVersion":{ "shape":"String", - "documentation":"

The upgraded version of the cache engine to be run on the cache nodes.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

" + "documentation":"

The upgraded version of the cache engine to be run on the cache nodes.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", @@ -2969,7 +3130,7 @@ }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", - "documentation":"

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" + "documentation":"

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", @@ -3001,7 +3162,7 @@ }, "EngineVersion":{ "shape":"String", - "documentation":"

The upgraded version of the cache engine to be run on the clusters in the replication group.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

" + "documentation":"

The upgraded version of the cache engine to be run on the clusters in the replication group.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", @@ -3059,11 +3220,11 @@ }, "NodeGroupsToRemove":{ "shape":"NodeGroupsToRemoveList", - "documentation":"

If the value of NodeGroupCount is less than the current number of node groups (shards), the NodeGroupsToRemove or NodeGroupsToRetain is a required list of node group ids to remove from or retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

" + "documentation":"

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

" }, "NodeGroupsToRetain":{ "shape":"NodeGroupsToRetainList", - "documentation":"

If the value of NodeGroupCount is less than the current number of node groups (shards), the NodeGroupsToRemove or NodeGroupsToRetain is a required list of node group ids to remove from or retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

" + "documentation":"

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

" } }, "documentation":"

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

" @@ -3091,7 +3252,7 @@ "members":{ "NodeGroupId":{ "shape":"String", - "documentation":"

The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.

" + "documentation":"

The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015. Optionally, the user can provide the id for a node group.

" }, "Status":{ "shape":"String", @@ -3117,7 +3278,7 @@ "members":{ "NodeGroupId":{ "shape":"AllowedNodeGroupId", - "documentation":"

The 4-digit id for the node group these configuration values apply to.

" + "documentation":"

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

" }, "Slots":{ "shape":"String", @@ -3185,6 +3346,55 @@ "locationName":"NodeGroupMember" } }, + "NodeGroupMemberUpdateStatus":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster ID

" + }, + "CacheNodeId":{ + "shape":"String", + "documentation":"

The node ID of the cache cluster

" + }, + "NodeUpdateStatus":{ + "shape":"NodeUpdateStatus", + "documentation":"

The update status of the node

" + }, + "NodeDeletionDate":{ + "shape":"TStamp", + "documentation":"

The deletion date of the node

" + }, + "NodeUpdateStartDate":{ + "shape":"TStamp", + "documentation":"

The start date of the update for a node

" + }, + "NodeUpdateEndDate":{ + "shape":"TStamp", + "documentation":"

The end date of the update for a node

" + }, + "NodeUpdateInitiatedBy":{ + "shape":"NodeUpdateInitiatedBy", + "documentation":"

Reflects whether the update was initiated by the customer or automatically applied

" + }, + "NodeUpdateInitiatedDate":{ + "shape":"TStamp", + "documentation":"

The date when the update is triggered

" + }, + "NodeUpdateStatusModifiedDate":{ + "shape":"TStamp", + "documentation":"

The date when the NodeUpdateStatus was last modified

" + } + }, + "documentation":"

The status of the service update on the node group member

" + }, + "NodeGroupMemberUpdateStatusList":{ + "type":"list", + "member":{ + "shape":"NodeGroupMemberUpdateStatus", + "locationName":"NodeGroupMemberUpdateStatus" + } + }, "NodeGroupNotFoundFault":{ "type":"structure", "members":{ @@ -3197,6 +3407,27 @@ }, "exception":true }, + "NodeGroupUpdateStatus":{ + "type":"structure", + "members":{ + "NodeGroupId":{ + "shape":"String", + "documentation":"

The ID of the node group

" + }, + "NodeGroupMemberUpdateStatus":{ + "shape":"NodeGroupMemberUpdateStatusList", + "documentation":"

The status of the service update on the node group member

" + } + }, + "documentation":"

The status of the service update on the node group

" + }, + "NodeGroupUpdateStatusList":{ + "type":"list", + "member":{ + "shape":"NodeGroupUpdateStatus", + "locationName":"NodeGroupUpdateStatus" + } + }, "NodeGroupsPerReplicationGroupQuotaExceededFault":{ "type":"structure", "members":{ @@ -3293,6 +3524,24 @@ "type":"list", "member":{"shape":"String"} }, + "NodeUpdateInitiatedBy":{ + "type":"string", + "enum":[ + "system", + "customer" + ] + }, + "NodeUpdateStatus":{ + "type":"string", + "enum":[ + "not-applied", + "waiting-to-start", + "in-progress", + "stopping", + "stopped", + "complete" + ] + }, "NotificationConfiguration":{ "type":"structure", "members":{ @@ -3344,7 +3593,7 @@ }, "ChangeType":{ "shape":"ChangeType", - "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" + "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" } }, "documentation":"

Describes an individual setting that controls some aspect of ElastiCache behavior.

" @@ -3413,6 +3662,31 @@ "locationName":"PreferredAvailabilityZone" } }, + "ProcessedUpdateAction":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "UpdateActionStatus":{ + "shape":"UpdateActionStatus", + "documentation":"

The status of the update action on the Redis cluster

" + } + }, + "documentation":"

Update action that has been processed for the corresponding apply/stop request

" + }, + "ProcessedUpdateActionList":{ + "type":"list", + "member":{ + "shape":"ProcessedUpdateAction", + "locationName":"ProcessedUpdateAction" + } + }, "PurchaseReservedCacheNodesOfferingMessage":{ "type":"structure", "required":["ReservedCacheNodesOfferingId"], @@ -3497,7 +3771,7 @@ "members":{ "ResourceName":{ "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "documentation":"

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" }, "TagKeys":{ "shape":"KeyList", @@ -3546,7 +3820,7 @@ }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", - "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" + "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" }, "ConfigurationEndpoint":{ "shape":"Endpoint", @@ -3596,6 +3870,11 @@ }, "exception":true }, + "ReplicationGroupIdList":{ + "type":"list", + "member":{"shape":"String"}, + "max":20 + }, "ReplicationGroupList":{ "type":"list", "member":{ @@ -3638,7 +3917,7 @@ }, "AutomaticFailoverStatus":{ "shape":"PendingAutomaticFailoverStatus", - "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" + "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" }, "Resharding":{ "shape":"ReshardingStatus", @@ -3660,7 +3939,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The cache node type for the reserved cache nodes.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The cache node type for the reserved cache nodes.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "StartTime":{ "shape":"TStamp", @@ -3772,7 +4051,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The cache node type for the reserved cache node.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The cache node type for the reserved cache node.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "Duration":{ "shape":"Integer", @@ -3859,7 +4138,7 @@ "members":{ "NodeGroupId":{ "shape":"AllowedNodeGroupId", - "documentation":"

The 4-digit id for the node group these configuration values apply to.

" + "documentation":"

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

" }, "PreferredAvailabilityZones":{ "shape":"AvailabilityZonesList", @@ -3951,6 +4230,126 @@ }, "exception":true }, + "ServiceUpdate":{ + "type":"structure", + "members":{ + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ServiceUpdateReleaseDate":{ + "shape":"TStamp", + "documentation":"

The date when the service update is initially available

" + }, + "ServiceUpdateEndDate":{ + "shape":"TStamp", + "documentation":"

The date after which the service update is no longer available

" + }, + "ServiceUpdateSeverity":{ + "shape":"ServiceUpdateSeverity", + "documentation":"

The severity of the service update

" + }, + "ServiceUpdateRecommendedApplyByDate":{ + "shape":"TStamp", + "documentation":"

The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatus", + "documentation":"

The status of the service update

" + }, + "ServiceUpdateDescription":{ + "shape":"String", + "documentation":"

Provides details of the service update

" + }, + "ServiceUpdateType":{ + "shape":"ServiceUpdateType", + "documentation":"

Reflects the nature of the service update

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The Redis engine to which the service update applies

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The Redis engine version to which the service update applies

" + }, + "AutoUpdateAfterRecommendedApplyByDate":{ + "shape":"BooleanOptional", + "documentation":"

Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.

" + }, + "EstimatedUpdateTime":{ + "shape":"String", + "documentation":"

The estimated length of time the service update will take

" + } + }, + "documentation":"

An update that you can apply to your Redis clusters.

" + }, + "ServiceUpdateList":{ + "type":"list", + "member":{ + "shape":"ServiceUpdate", + "locationName":"ServiceUpdate" + } + }, + "ServiceUpdateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The service update doesn't exist

", + "error":{ + "code":"ServiceUpdateNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ServiceUpdateSeverity":{ + "type":"string", + "enum":[ + "critical", + "important", + "medium", + "low" + ] + }, + "ServiceUpdateStatus":{ + "type":"string", + "enum":[ + "available", + "cancelled", + "expired" + ] + }, + "ServiceUpdateStatusList":{ + "type":"list", + "member":{"shape":"ServiceUpdateStatus"}, + "max":3 + }, + "ServiceUpdateType":{ + "type":"string", + "enum":["security-update"] + }, + "ServiceUpdatesMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ServiceUpdates":{ + "shape":"ServiceUpdateList", + "documentation":"

A list of service updates

" + } + } + }, + "SlaMet":{ + "type":"string", + "enum":[ + "yes", + "no", + "n/a" + ] + }, "SlotMigration":{ "type":"structure", "members":{ @@ -3990,7 +4389,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"

The name of the compute and memory capacity node type for the source cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Notes:

For a complete listing of node types and specifications, see:

" + "documentation":"

The name of the compute and memory capacity node type for the source cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

Additional node type info

" }, "Engine":{ "shape":"String", @@ -4054,7 +4453,7 @@ }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", - "documentation":"

Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" + "documentation":"

Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

" }, "NodeSnapshots":{ "shape":"NodeSnapshotList", @@ -4267,6 +4666,160 @@ "members":{ "ReplicationGroup":{"shape":"ReplicationGroup"} } + }, + "TimeRangeFilter":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"TStamp", + "documentation":"

The start time of the time range filter

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end time of the time range filter

" + } + }, + "documentation":"

Filters update actions from the service updates that are in available status during the time range.

" + }, + "UnprocessedUpdateAction":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group ID

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ErrorType":{ + "shape":"String", + "documentation":"

The error type for requests that are not processed

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message that describes the reason the request was not processed

" + } + }, + "documentation":"

Update action that has failed to be processed for the corresponding apply/stop request

" + }, + "UnprocessedUpdateActionList":{ + "type":"list", + "member":{ + "shape":"UnprocessedUpdateAction", + "locationName":"UnprocessedUpdateAction" + } + }, + "UpdateAction":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ServiceUpdateReleaseDate":{ + "shape":"TStamp", + "documentation":"

The date the update is first available

" + }, + "ServiceUpdateSeverity":{ + "shape":"ServiceUpdateSeverity", + "documentation":"

The severity of the service update

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatus", + "documentation":"

The status of the service update

" + }, + "ServiceUpdateRecommendedApplyByDate":{ + "shape":"TStamp", + "documentation":"

The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" + }, + "ServiceUpdateType":{ + "shape":"ServiceUpdateType", + "documentation":"

Reflects the nature of the service update

" + }, + "UpdateActionAvailableDate":{ + "shape":"TStamp", + "documentation":"

The date that the service update is available to a replication group

" + }, + "UpdateActionStatus":{ + "shape":"UpdateActionStatus", + "documentation":"

The status of the update action

" + }, + "NodesUpdated":{ + "shape":"String", + "documentation":"

The progress of the service update on the replication group

" + }, + "UpdateActionStatusModifiedDate":{ + "shape":"TStamp", + "documentation":"

The date when the UpdateActionStatus was last modified

" + }, + "SlaMet":{ + "shape":"SlaMet", + "documentation":"

If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.

" + }, + "NodeGroupUpdateStatus":{ + "shape":"NodeGroupUpdateStatusList", + "documentation":"

The status of the service update on the node group

" + }, + "EstimatedUpdateTime":{ + "shape":"String", + "documentation":"

The estimated length of time for the update to complete

" + } + }, + "documentation":"

The status of the service update for a specific replication group

" + }, + "UpdateActionList":{ + "type":"list", + "member":{ + "shape":"UpdateAction", + "locationName":"UpdateAction" + } + }, + "UpdateActionResultsMessage":{ + "type":"structure", + "members":{ + "ProcessedUpdateActions":{ + "shape":"ProcessedUpdateActionList", + "documentation":"

Update actions that have been processed successfully

" + }, + "UnprocessedUpdateActions":{ + "shape":"UnprocessedUpdateActionList", + "documentation":"

Update actions that haven't been processed successfully

" + } + } + }, + "UpdateActionStatus":{ + "type":"string", + "enum":[ + "not-applied", + "waiting-to-start", + "in-progress", + "stopping", + "stopped", + "complete" + ] + }, + "UpdateActionStatusList":{ + "type":"list", + "member":{"shape":"UpdateActionStatus"}, + "max":6 + }, + "UpdateActionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "UpdateActions":{ + "shape":"UpdateActionList", + "documentation":"

Returns a list of update actions

" + } + } } }, "documentation":"Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

" diff --git a/botocore/data/iam/2010-05-08/service-2.json b/botocore/data/iam/2010-05-08/service-2.json index 8e142dc694..14f8d4360e 100644 --- a/botocore/data/iam/2010-05-08/service-2.json +++ b/botocore/data/iam/2010-05-08/service-2.json @@ -2794,7 +2794,7 @@ }, "AssumeRolePolicyDocument":{ "shape":"policyDocumentType", - "documentation":"

The trust relationship policy document that grants an entity permission to assume the role.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

" + "documentation":"

The trust relationship policy document that grants an entity permission to assume the role.

in IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

Upon success, the response includes the same trust policy as a URL-encoded JSON string.

" }, "Description":{ "shape":"roleDescriptionType", @@ -7823,6 +7823,8 @@ }, "policyPathType":{ "type":"string", + "max":512, + "min":1, "pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/" }, "policyScopeType":{ diff --git a/botocore/data/s3/2006-03-01/service-2.json b/botocore/data/s3/2006-03-01/service-2.json index b24f7fd7ed..ac06e5f005 100644 --- a/botocore/data/s3/2006-03-01/service-2.json +++ b/botocore/data/s3/2006-03-01/service-2.json @@ -101,7 +101,7 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketAnalyticsConfigurationRequest"}, - "documentation":"

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

" + "documentation":"

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.

" }, "DeleteBucketCors":{ "name":"DeleteBucketCors", @@ -502,7 +502,7 @@ }, "input":{"shape":"GetObjectLockConfigurationRequest"}, "output":{"shape":"GetObjectLockConfigurationOutput"}, - "documentation":"

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

" + "documentation":"

Gets the object lock configuration for a bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.

" }, "GetObjectRetention":{ "name":"GetObjectRetention", @@ -798,7 +798,7 @@ }, "input":{"shape":"PutBucketPolicyRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html", - "documentation":"

Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.

" + "documentation":"

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

" }, "PutBucketReplication":{ "name":"PutBucketReplication", @@ -807,7 +807,7 @@ "requestUri":"/{Bucket}?replication" }, "input":{"shape":"PutBucketReplicationRequest"}, - "documentation":"

Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

" + "documentation":"

Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

" }, "PutBucketRequestPayment":{ "name":"PutBucketRequestPayment", @@ -892,7 +892,7 @@ }, "input":{"shape":"PutObjectLockConfigurationRequest"}, "output":{"shape":"PutObjectLockConfigurationOutput"}, - "documentation":"

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.

" + "documentation":"

Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.

" }, "PutObjectRetention":{ "name":"PutObjectRetention", @@ -982,10 +982,10 @@ "members":{ "DaysAfterInitiation":{ "shape":"DaysAfterInitiation", - "documentation":"

Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload.

" + "documentation":"

Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

" } }, - "documentation":"

Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.

" + "documentation":"

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon Simple Storage Service Developer Guide.

" }, "AbortMultipartUploadOutput":{ "type":"structure", @@ -1007,19 +1007,19 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

", + "documentation":"

Name of the bucket to which the multipart upload was initiated.

", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", - "documentation":"

", + "documentation":"

Key of the object for which the multipart upload was initiated.

", "location":"uri", "locationName":"Key" }, "UploadId":{ "shape":"MultipartUploadId", - "documentation":"

", + "documentation":"

Upload ID that identifies the multipart upload.

", "location":"querystring", "locationName":"uploadId" }, @@ -1036,10 +1036,10 @@ "members":{ "Status":{ "shape":"BucketAccelerateStatus", - "documentation":"

The accelerate configuration of the bucket.

" + "documentation":"

Specifies the transfer acceleration status of the bucket.

" } }, - "documentation":"

" + "documentation":"

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.

" }, "AcceptRanges":{"type":"string"}, "AccessControlPolicy":{ @@ -1052,10 +1052,10 @@ }, "Owner":{ "shape":"Owner", - "documentation":"

" + "documentation":"

Container for the bucket owner's display name and ID.

" } }, - "documentation":"

" + "documentation":"

Contains the elements that set the ACL permissions for an object per grantee.

" }, "AccessControlTranslation":{ "type":"structure", @@ -1063,7 +1063,7 @@ "members":{ "Owner":{ "shape":"OwnerOverride", - "documentation":"

The override value for the owner of the replica object.

" + "documentation":"

Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon Simple Storage Service API Reference.

" } }, "documentation":"

A container for information about access control for replicas.

" @@ -1093,7 +1093,7 @@ "members":{ "Prefix":{ "shape":"Prefix", - "documentation":"

The prefix to use when evaluating an AND predicate.

" + "documentation":"

The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

" }, "Tags":{ "shape":"TagSet", @@ -1102,7 +1102,7 @@ "locationName":"Tag" } }, - "documentation":"

" + "documentation":"

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.

" }, "AnalyticsConfiguration":{ "type":"structure", @@ -1113,7 +1113,7 @@ "members":{ "Id":{ "shape":"AnalyticsId", - "documentation":"

The identifier used to represent an analytics configuration.

" + "documentation":"

The ID that identifies the analytics configuration.

" }, "Filter":{ "shape":"AnalyticsFilter", @@ -1121,10 +1121,10 @@ }, "StorageClassAnalysis":{ "shape":"StorageClassAnalysis", - "documentation":"

If present, it indicates that data related to access patterns will be collected and made available to analyze the tradeoffs between different storage classes.

" + "documentation":"

Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

" } }, - "documentation":"

" + "documentation":"

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

For more information, see GET Bucket analytics in the Amazon Simple Storage Service API Reference.

" }, "AnalyticsConfigurationList":{ "type":"list", @@ -1140,7 +1140,7 @@ "documentation":"

A destination signifying output to an S3 bucket.

" } }, - "documentation":"

" + "documentation":"

Where to publish the analytics results.

" }, "AnalyticsFilter":{ "type":"structure", @@ -1170,7 +1170,7 @@ "members":{ "Format":{ "shape":"AnalyticsS3ExportFileFormat", - "documentation":"

The file format used when exporting data to Amazon S3.

" + "documentation":"

Specifies the file format used when exporting data to Amazon S3.

" }, "BucketAccountId":{ "shape":"AccountId", @@ -1178,11 +1178,11 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"

The Amazon resource name (ARN) of the bucket to which data is exported.

" + "documentation":"

The Amazon Resource Name (ARN) of the bucket to which data is exported.

" }, "Prefix":{ "shape":"Prefix", - "documentation":"

The prefix to use when exporting data. The exported data begins with this prefix.

" + "documentation":"

The prefix to use when exporting data. The prefix is prepended to all results.

" } }, "documentation":"

" @@ -1242,11 +1242,11 @@ "members":{ "Rules":{ "shape":"LifecycleRules", - "documentation":"

", + "documentation":"

A lifecycle rule for individual objects in an Amazon S3 bucket.

", "locationName":"Rule" } }, - "documentation":"

" + "documentation":"

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide.

" }, "BucketLocationConstraint":{ "type":"string", @@ -1267,7 +1267,10 @@ "BucketLoggingStatus":{ "type":"structure", "members":{ - "LoggingEnabled":{"shape":"LoggingEnabled"} + "LoggingEnabled":{ + "shape":"LoggingEnabled", + "documentation":"

" + } }, "documentation":"

" }, @@ -1304,11 +1307,11 @@ "members":{ "CORSRules":{ "shape":"CORSRules", - "documentation":"

", + "documentation":"

A set of allowed origins and methods.

", "locationName":"CORSRule" } }, - "documentation":"

" + "documentation":"

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

" }, "CORSRule":{ "type":"structure", @@ -1319,12 +1322,12 @@ "members":{ "AllowedHeaders":{ "shape":"AllowedHeaders", - "documentation":"

Specifies which headers are allowed in a pre-flight OPTIONS request.

", + "documentation":"

Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

", "locationName":"AllowedHeader" }, "AllowedMethods":{ "shape":"AllowedMethods", - "documentation":"

Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.

", + "documentation":"

An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

", "locationName":"AllowedMethod" }, "AllowedOrigins":{ @@ -1334,7 +1337,7 @@ }, "ExposeHeaders":{ "shape":"ExposeHeaders", - "documentation":"

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

", + "documentation":"

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

", "locationName":"ExposeHeader" }, "MaxAgeSeconds":{ @@ -1342,7 +1345,7 @@ "documentation":"

The time in seconds that your browser is to cache the preflight response for the specified resource.

" } }, - "documentation":"

" + "documentation":"

Specifies a cross-origin access rule for an Amazon S3 bucket.

" }, "CORSRules":{ "type":"list", @@ -1586,14 +1589,14 @@ "members":{ "HttpErrorCodeReturnedEquals":{ "shape":"HttpErrorCodeReturnedEquals", - "documentation":"

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

" + "documentation":"

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

" }, "KeyPrefixEquals":{ "shape":"KeyPrefixEquals", - "documentation":"

The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

" + "documentation":"

The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

" } }, - "documentation":"

" + "documentation":"

Specifies a condition that must be met for a redirect to apply.

" }, "ConfirmRemoveSelfBucketAccess":{"type":"boolean"}, "ContentDisposition":{"type":"string"}, @@ -1874,13 +1877,13 @@ }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode that you want to apply to the copied object.

", + "documentation":"

The object lock mode that you want to apply to the copied object.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when you want the copied object's Object Lock to expire.

", + "documentation":"

The date and time when you want the copied object's object lock to expire.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, @@ -2011,7 +2014,7 @@ }, "ObjectLockEnabledForBucket":{ "shape":"ObjectLockEnabledForBucket", - "documentation":"

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

", + "documentation":"

Specifies whether you want Amazon S3 object lock to be enabled for the new bucket.

", "location":"header", "locationName":"x-amz-bucket-object-lock-enabled" } @@ -2223,13 +2226,13 @@ }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

Specifies the Object Lock mode that you want to apply to the uploaded object.

", + "documentation":"

Specifies the object lock mode that you want to apply to the uploaded object.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

Specifies the date and time when you want the Object Lock to expire.

", + "documentation":"

Specifies the date and time when you want the object lock to expire.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, @@ -2253,7 +2256,7 @@ "members":{ "Mode":{ "shape":"ObjectLockRetentionMode", - "documentation":"

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.

" + "documentation":"

The default object lock retention mode you want to apply to new objects placed in the specified bucket.

" }, "Days":{ "shape":"Days", @@ -2264,7 +2267,7 @@ "documentation":"

The number of years that you want to specify for the default retention period.

" } }, - "documentation":"

The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.

" + "documentation":"

The container element for specifying the default object lock retention settings for new objects placed in the specified bucket.

" }, "Delete":{ "type":"structure", @@ -2297,7 +2300,7 @@ }, "Id":{ "shape":"AnalyticsId", - "documentation":"

The identifier used to represent an analytics configuration.

", + "documentation":"

The ID that identifies the analytics configuration.

", "location":"querystring", "locationName":"id" } @@ -2551,7 +2554,7 @@ }, "BypassGovernanceRetention":{ "shape":"BypassGovernanceRetention", - "documentation":"

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

", + "documentation":"

Indicates whether Amazon S3 object lock should bypass governance-mode restrictions to process this operation.

", "location":"header", "locationName":"x-amz-bypass-governance-retention" } @@ -2646,7 +2649,7 @@ }, "BypassGovernanceRetention":{ "shape":"BypassGovernanceRetention", - "documentation":"

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.

", + "documentation":"

Specifies whether you want to delete this object even if it has a Governance-type object lock in place. You must have sufficient permissions to perform this operation.

", "location":"header", "locationName":"x-amz-bypass-governance-retention" } @@ -2700,26 +2703,26 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.

If there are multiple rules in your replication configuration, all rules must specify the same bucket as the destination. A replication configuration can replicate objects to only one destination bucket.

" + "documentation":"

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.

A replication configuration can replicate objects to only one destination bucket. If there are multiple rules in your replication configuration, all rules must specify the same destination bucket.

" }, "Account":{ "shape":"AccountId", - "documentation":"

The account ID of the destination bucket. Currently, Amazon S3 verifies this value only if Access Control Translation is enabled.

In a cross-account scenario, if you change replica ownership to the AWS account that owns the destination bucket by adding the AccessControlTranslation element, this is the account ID of the owner of the destination bucket.

" + "documentation":"

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Cross-Region Replication Additional Configuration: Change Replica Owner in the Amazon Simple Storage Service Developer Guide.

" }, "StorageClass":{ "shape":"StorageClass", - "documentation":"

The class of storage used to store the object. By default Amazon S3 uses storage class of the source object when creating a replica.

" + "documentation":"

The storage class to use when replicating objects, such as standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon Simple Storage Service API Reference.

" }, "AccessControlTranslation":{ "shape":"AccessControlTranslation", - "documentation":"

A container for information about access control for replicas.

Use this element only in a cross-account scenario where source and destination bucket owners are not the same to change replica ownership to the AWS account that owns the destination bucket. If you don't add this element to the replication configuration, the replicas are owned by same AWS account that owns the source object.

" + "documentation":"

Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.

" }, "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", - "documentation":"

A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

" + "documentation":"

A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

" } }, - "documentation":"

A container for information about the replication destination.

" + "documentation":"

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.

" }, "DisplayName":{"type":"string"}, "ETag":{"type":"string"}, @@ -2754,10 +2757,10 @@ "members":{ "ReplicaKmsKeyID":{ "shape":"ReplicaKmsKeyID", - "documentation":"

The ID of the AWS KMS key for the AWS Region where the destination bucket resides. Amazon S3 uses this key to encrypt the replica object.

" + "documentation":"

Specifies the AWS KMS Key ID (Key ARN or Alias ARN) for the destination bucket. Amazon S3 uses this key to encrypt replica objects.

" } }, - "documentation":"

A container for information about the encryption-based configuration for replicas.

" + "documentation":"

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

" }, "EndEvent":{ "type":"structure", @@ -2862,14 +2865,14 @@ "members":{ "Name":{ "shape":"FilterRuleName", - "documentation":"

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum prefix length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.

" + "documentation":"

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.

" }, "Value":{ "shape":"FilterRuleValue", - "documentation":"

" + "documentation":"

The value that the filter searches for in object key names.

" } }, - "documentation":"

A container for a key value pair that defines the criteria for the filter rule.

" + "documentation":"

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

" }, "FilterRuleList":{ "type":"list", @@ -2957,7 +2960,7 @@ }, "Id":{ "shape":"AnalyticsId", - "documentation":"

The identifier used to represent an analytics configuration.

", + "documentation":"

The ID that identifies the analytics configuration.

", "location":"querystring", "locationName":"id" } @@ -2988,7 +2991,10 @@ "GetBucketEncryptionOutput":{ "type":"structure", "members":{ - "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"} + "ServerSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

" + } }, "payload":"ServerSideEncryptionConfiguration" }, @@ -3103,7 +3109,10 @@ "GetBucketLoggingOutput":{ "type":"structure", "members":{ - "LoggingEnabled":{"shape":"LoggingEnabled"} + "LoggingEnabled":{ + "shape":"LoggingEnabled", + "documentation":"

" + } } }, "GetBucketLoggingRequest":{ @@ -3208,7 +3217,10 @@ "GetBucketReplicationOutput":{ "type":"structure", "members":{ - "ReplicationConfiguration":{"shape":"ReplicationConfiguration"} + "ReplicationConfiguration":{ + "shape":"ReplicationConfiguration", + "documentation":"

" + } }, "payload":"ReplicationConfiguration" }, @@ -3424,7 +3436,7 @@ "members":{ "ObjectLockConfiguration":{ "shape":"ObjectLockConfiguration", - "documentation":"

The specified bucket's Object Lock configuration.

" + "documentation":"

The specified bucket's object lock configuration.

" } }, "payload":"ObjectLockConfiguration" @@ -3435,7 +3447,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket whose Object Lock configuration you want to retrieve.

", + "documentation":"

The bucket whose object lock configuration you want to retrieve.

", "location":"uri", "locationName":"Bucket" } @@ -3612,13 +3624,13 @@ }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode currently in place for this object.

", + "documentation":"

The object lock mode currently in place for this object.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when this object's Object Lock will expire.

", + "documentation":"

The date and time when this object's object lock will expire.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, @@ -4138,13 +4150,13 @@ }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode currently in place for this object.

", + "documentation":"

The object lock mode currently in place for this object.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when this object's Object Lock will expire.

", + "documentation":"

The date and time when this object's object lock expires.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, @@ -4314,7 +4326,7 @@ }, "IsEnabled":{ "shape":"IsEnabled", - "documentation":"

Specifies whether the inventory is enabled or disabled.

" + "documentation":"

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

" }, "Filter":{ "shape":"InventoryFilter", @@ -4326,7 +4338,7 @@ }, "IncludedObjectVersions":{ "shape":"InventoryIncludedObjectVersions", - "documentation":"

Specifies which object version(s) to included in the inventory results.

" + "documentation":"

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

" }, "OptionalFields":{ "shape":"InventoryOptionalFields", @@ -4337,7 +4349,7 @@ "documentation":"

Specifies the schedule for generating inventory results.

" } }, - "documentation":"

" + "documentation":"

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon Simple Storage Service API Reference.

" }, "InventoryConfigurationList":{ "type":"list", @@ -4514,15 +4526,18 @@ "Id":{"shape":"NotificationId"}, "LambdaFunctionArn":{ "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of the Lambda cloud function that Amazon S3 can invoke when it detects events of the specified type.

", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.

", "locationName":"CloudFunction" }, "Events":{ "shape":"EventList", - "documentation":"

", + "documentation":"

The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide.

", "locationName":"Event" }, - "Filter":{"shape":"NotificationConfigurationFilter"} + "Filter":{ + "shape":"NotificationConfigurationFilter", + "documentation":"

" + } }, "documentation":"

A container for specifying the configuration for AWS Lambda notifications.

" }, @@ -4579,7 +4594,10 @@ "documentation":"

Prefix identifying one or more objects to which the rule applies. This is No longer used; use Filter instead.

", "deprecated":true }, - "Filter":{"shape":"LifecycleRuleFilter"}, + "Filter":{ + "shape":"LifecycleRuleFilter", + "documentation":"

" + }, "Status":{ "shape":"ExpirationStatus", "documentation":"

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

" @@ -4594,8 +4612,14 @@ "documentation":"

", "locationName":"NoncurrentVersionTransition" }, - "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"}, - "AbortIncompleteMultipartUpload":{"shape":"AbortIncompleteMultipartUpload"} + "NoncurrentVersionExpiration":{ + "shape":"NoncurrentVersionExpiration", + "documentation":"

" + }, + "AbortIncompleteMultipartUpload":{ + "shape":"AbortIncompleteMultipartUpload", + "documentation":"

" + } }, "documentation":"

" }, @@ -4626,7 +4650,10 @@ "shape":"Tag", "documentation":"

This tag must exist in the object's tag set in order for the rule to apply.

" }, - "And":{"shape":"LifecycleRuleAndOperator"} + "And":{ + "shape":"LifecycleRuleAndOperator", + "documentation":"

" + } }, "documentation":"

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.

" }, @@ -5311,10 +5338,10 @@ }, "TargetPrefix":{ "shape":"TargetPrefix", - "documentation":"

This element lets you specify a prefix for the keys that the log files will be stored under.

" + "documentation":"

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

" } }, - "documentation":"

Container for logging information. Presence of this element indicates that logging is enabled. Parameters TargetBucket and TargetPrefix are required in this case.

" + "documentation":"

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon Simple Storage Service API Reference.

" }, "MFA":{"type":"string"}, "MFADelete":{ @@ -5394,7 +5421,7 @@ "documentation":"

Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).

" } }, - "documentation":"

" + "documentation":"

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics in the Amazon Simple Storage Service API Reference.

" }, "MetricsConfigurationList":{ "type":"list", @@ -5499,14 +5526,14 @@ "members":{ "NoncurrentDays":{ "shape":"Days", - "documentation":"

Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.

" + "documentation":"

Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.

" }, "StorageClass":{ "shape":"TransitionStorageClass", "documentation":"

The class of storage used to store the object.

" } }, - "documentation":"

Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

" + "documentation":"

Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

" }, "NoncurrentVersionTransitionList":{ "type":"list", @@ -5518,17 +5545,17 @@ "members":{ "TopicConfigurations":{ "shape":"TopicConfigurationList", - "documentation":"

", + "documentation":"

The topic to which notifications are sent and the events for which notifications are generated.

", "locationName":"TopicConfiguration" }, "QueueConfigurations":{ "shape":"QueueConfigurationList", - "documentation":"

", + "documentation":"

The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

", "locationName":"QueueConfiguration" }, "LambdaFunctionConfigurations":{ "shape":"LambdaFunctionConfigurationList", - "documentation":"

", + "documentation":"

Describes the AWS Lambda functions to invoke and the events for which to invoke them.

", "locationName":"CloudFunctionConfiguration" } }, @@ -5556,10 +5583,11 @@ "members":{ "Key":{ "shape":"S3KeyFilter", + "documentation":"

", "locationName":"S3Key" } }, - "documentation":"

A container for object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.

" + "documentation":"

Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.

" }, "NotificationId":{ "type":"string", @@ -5648,14 +5676,14 @@ "members":{ "ObjectLockEnabled":{ "shape":"ObjectLockEnabled", - "documentation":"

Indicates whether this bucket has an Object Lock configuration enabled.

" + "documentation":"

Indicates whether this bucket has an object lock configuration enabled.

" }, "Rule":{ "shape":"ObjectLockRule", - "documentation":"

The Object Lock rule in place for the specified object.

" + "documentation":"

The object lock rule in place for the specified object.

" } }, - "documentation":"

The container element for Object Lock configuration parameters.

" + "documentation":"

The container element for object lock configuration parameters.

" }, "ObjectLockEnabled":{ "type":"string", @@ -5699,7 +5727,7 @@ }, "RetainUntilDate":{ "shape":"Date", - "documentation":"

The date on which this Object Lock Retention will expire.

" + "documentation":"

The date on which this object lock retention expires.

" } }, "documentation":"

A Retention configuration for an object.

" @@ -5719,7 +5747,7 @@ "documentation":"

The default retention period that you want to apply to new objects placed in the specified bucket.

" } }, - "documentation":"

The container element for an Object Lock rule.

" + "documentation":"

The container element for an object lock rule.

" }, "ObjectLockToken":{"type":"string"}, "ObjectNotInActiveTierError":{ @@ -5959,7 +5987,7 @@ "locationName":"RestrictPublicBuckets" } }, - "documentation":"

" + "documentation":"

Specifies the Block Public Access configuration for an Amazon S3 bucket.

" }, "PutBucketAccelerateConfigurationRequest":{ "type":"structure", @@ -5995,7 +6023,7 @@ }, "AccessControlPolicy":{ "shape":"AccessControlPolicy", - "documentation":"

", + "documentation":"

Contains the elements that set the ACL permissions for an object per grantee.

", "locationName":"AccessControlPolicy", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, @@ -6060,7 +6088,7 @@ }, "Id":{ "shape":"AnalyticsId", - "documentation":"

The identifier used to represent an analytics configuration.

", + "documentation":"

The ID that identifies the analytics configuration.

", "location":"querystring", "locationName":"id" }, @@ -6110,18 +6138,19 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The name of the bucket for which the server-side encryption configuration is set.

", + "documentation":"

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.

", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. This parameter is auto-populated when using the command from the CLI

", + "documentation":"

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. This parameter is auto-populated when using the command from the CLI.

", "location":"header", "locationName":"Content-MD5" }, "ServerSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", + "documentation":"

", "locationName":"ServerSideEncryptionConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } @@ -6273,6 +6302,7 @@ }, "NotificationConfiguration":{ "shape":"NotificationConfiguration", + "documentation":"

", "locationName":"NotificationConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } @@ -6354,18 +6384,19 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"

", + "documentation":"

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit.

", "location":"header", "locationName":"Content-MD5" }, "ReplicationConfiguration":{ "shape":"ReplicationConfiguration", + "documentation":"

", "locationName":"ReplicationConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "Token":{ "shape":"ObjectLockToken", - "documentation":"

", + "documentation":"

A token that allows Amazon S3 object lock to be enabled for an existing bucket.

", "location":"header", "locationName":"x-amz-bucket-object-lock-token" } @@ -6515,7 +6546,7 @@ }, "AccessControlPolicy":{ "shape":"AccessControlPolicy", - "documentation":"

", + "documentation":"

Contains the elements that set the ACL permissions for an object per grantee.

", "locationName":"AccessControlPolicy", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, @@ -6652,13 +6683,13 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"

The bucket whose Object Lock configuration you want to create or replace.

", + "documentation":"

The bucket whose object lock configuration you want to create or replace.

", "location":"uri", "locationName":"Bucket" }, "ObjectLockConfiguration":{ "shape":"ObjectLockConfiguration", - "documentation":"

The Object Lock configuration that you want to apply to the specified bucket.

", + "documentation":"

The object lock configuration that you want to apply to the specified bucket.

", "locationName":"ObjectLockConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, @@ -6669,7 +6700,7 @@ }, "Token":{ "shape":"ObjectLockToken", - "documentation":"

A token to allow Object Lock to be enabled for an existing bucket.

", + "documentation":"

A token to allow Amazon S3 object lock to be enabled for an existing bucket.

", "location":"header", "locationName":"x-amz-bucket-object-lock-token" }, @@ -6790,7 +6821,7 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI

", + "documentation":"

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameted is required if object lock parameters are specified.

", "location":"header", "locationName":"Content-MD5" }, @@ -6897,13 +6928,13 @@ }, "ObjectLockMode":{ "shape":"ObjectLockMode", - "documentation":"

The Object Lock mode that you want to apply to this object.

", + "documentation":"

The object lock mode that you want to apply to this object.

", "location":"header", "locationName":"x-amz-object-lock-mode" }, "ObjectLockRetainUntilDate":{ "shape":"ObjectLockRetainUntilDate", - "documentation":"

The date and time when you want this object's Object Lock to expire.

", + "documentation":"

The date and time when you want this object's object lock to expire.

", "location":"header", "locationName":"x-amz-object-lock-retain-until-date" }, @@ -7068,7 +7099,7 @@ "Id":{"shape":"NotificationId"}, "QueueArn":{ "shape":"QueueArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 will publish a message when it detects events of the specified type.

", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

", "locationName":"Queue" }, "Events":{ @@ -7076,9 +7107,12 @@ "documentation":"

", "locationName":"Event" }, - "Filter":{"shape":"NotificationConfigurationFilter"} + "Filter":{ + "shape":"NotificationConfigurationFilter", + "documentation":"

" + } }, - "documentation":"

A container for specifying the configuration for publication of messages to an Amazon Simple Queue Service (Amazon SQS) queue.when Amazon S3 detects specified events.

" + "documentation":"

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

" }, "QueueConfigurationDeprecated":{ "type":"structure", @@ -7142,18 +7176,18 @@ }, "Protocol":{ "shape":"Protocol", - "documentation":"

Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.

" + "documentation":"

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

" }, "ReplaceKeyPrefixWith":{ "shape":"ReplaceKeyPrefixWith", - "documentation":"

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

" + "documentation":"

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

" }, "ReplaceKeyWith":{ "shape":"ReplaceKeyWith", - "documentation":"

The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.

" + "documentation":"

The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

" } }, - "documentation":"

" + "documentation":"

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

" }, "RedirectAllRequestsTo":{ "type":"structure", @@ -7161,14 +7195,14 @@ "members":{ "HostName":{ "shape":"HostName", - "documentation":"

Name of the host where requests will be redirected.

" + "documentation":"

Name of the host where requests are redirected.

" }, "Protocol":{ "shape":"Protocol", - "documentation":"

Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.

" + "documentation":"

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

" } }, - "documentation":"

" + "documentation":"

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

" }, "ReplaceKeyPrefixWith":{"type":"string"}, "ReplaceKeyWith":{"type":"string"}, @@ -7182,7 +7216,7 @@ "members":{ "Role":{ "shape":"Role", - "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 can assume when replicating the objects.

" + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Cross-Region Replication in the Amazon Simple Storage Service Developer Guide.

" }, "Rules":{ "shape":"ReplicationRules", @@ -7209,25 +7243,31 @@ }, "Prefix":{ "shape":"Prefix", - "documentation":"

An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters.

", + "documentation":"

An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.

", "deprecated":true }, - "Filter":{"shape":"ReplicationRuleFilter"}, + "Filter":{ + "shape":"ReplicationRuleFilter", + "documentation":"

" + }, "Status":{ "shape":"ReplicationRuleStatus", - "documentation":"

If status isn't enabled, the rule is ignored.

" + "documentation":"

Specifies whether the rule is enabled.

" }, "SourceSelectionCriteria":{ "shape":"SourceSelectionCriteria", - "documentation":"

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS).

If you want Amazon S3 to replicate objects created with server-side encryption using AWS KMS-Managed Keys.

" + "documentation":"

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS).

" }, "Destination":{ "shape":"Destination", "documentation":"

A container for information about the replication destination.

" }, - "DeleteMarkerReplication":{"shape":"DeleteMarkerReplication"} + "DeleteMarkerReplication":{ + "shape":"DeleteMarkerReplication", + "documentation":"

" + } }, - "documentation":"

A container for information about a specific replication rule.

" + "documentation":"

Specifies which Amazon S3 objects to replicate and where to store the replicas.

" }, "ReplicationRuleAndOperator":{ "type":"structure", @@ -7365,6 +7405,7 @@ }, "RestoreRequest":{ "shape":"RestoreRequest", + "documentation":"

", "locationName":"RestoreRequest", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, @@ -7422,14 +7463,14 @@ "members":{ "Condition":{ "shape":"Condition", - "documentation":"

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

" + "documentation":"

A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

" }, "Redirect":{ "shape":"Redirect", "documentation":"

Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

" } }, - "documentation":"

" + "documentation":"

Specifies the redirect behavior and when a redirect is applied.

" }, "RoutingRules":{ "type":"list", @@ -7451,25 +7492,34 @@ }, "ID":{ "shape":"ID", - "documentation":"

Unique identifier for the rule. The value cannot be longer than 255 characters.

" + "documentation":"

Unique identifier for the rule. The value can't be longer than 255 characters.

" }, "Prefix":{ "shape":"Prefix", - "documentation":"

Prefix identifying one or more objects to which the rule applies.

" + "documentation":"

Object key prefix that identifies one or more objects to which this rule applies.

" }, "Status":{ "shape":"ExpirationStatus", - "documentation":"

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

" + "documentation":"

If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.

" }, "Transition":{ "shape":"Transition", "documentation":"

" }, - "NoncurrentVersionTransition":{"shape":"NoncurrentVersionTransition"}, - "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"}, - "AbortIncompleteMultipartUpload":{"shape":"AbortIncompleteMultipartUpload"} + "NoncurrentVersionTransition":{ + "shape":"NoncurrentVersionTransition", + "documentation":"

" + }, + "NoncurrentVersionExpiration":{ + "shape":"NoncurrentVersionExpiration", + "documentation":"

" + }, + "AbortIncompleteMultipartUpload":{ + "shape":"AbortIncompleteMultipartUpload", + "documentation":"

" + } }, - "documentation":"

" + "documentation":"

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see PUT Bucket lifecycle in the Amazon Simple Storage Service API Reference.

" }, "Rules":{ "type":"list", @@ -7481,6 +7531,7 @@ "members":{ "FilterRules":{ "shape":"FilterRuleList", + "documentation":"

", "locationName":"FilterRule" } }, @@ -7501,7 +7552,10 @@ "shape":"LocationPrefix", "documentation":"

The prefix that is prepended to the restore results for this request.

" }, - "Encryption":{"shape":"Encryption"}, + "Encryption":{ + "shape":"Encryption", + "documentation":"

" + }, "CannedACL":{ "shape":"ObjectCannedACL", "documentation":"

The canned ACL to apply to the restore results.

" @@ -7700,10 +7754,10 @@ }, "KMSMasterKeyID":{ "shape":"SSEKMSKeyId", - "documentation":"

KMS master key ID to use for the default encryption. This parameter is allowed if SSEAlgorithm is aws:kms.

" + "documentation":"

KMS master key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

" } }, - "documentation":"

Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied.

" + "documentation":"

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption in the Amazon Simple Storage Service API Reference.

" }, "ServerSideEncryptionConfiguration":{ "type":"structure", @@ -7715,17 +7769,17 @@ "locationName":"Rule" } }, - "documentation":"

Container for server-side encryption configuration rules. Currently S3 supports one rule only.

" + "documentation":"

Specifies the default server-side-encryption configuration.

" }, "ServerSideEncryptionRule":{ "type":"structure", "members":{ "ApplyServerSideEncryptionByDefault":{ "shape":"ServerSideEncryptionByDefault", - "documentation":"

Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied.

" + "documentation":"

Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

" } }, - "documentation":"

Container for information about a particular server-side encryption configuration rule.

" + "documentation":"

Specifies the default server-side encryption configuration.

" }, "ServerSideEncryptionRules":{ "type":"list", @@ -7739,10 +7793,10 @@ "members":{ "SseKmsEncryptedObjects":{ "shape":"SseKmsEncryptedObjects", - "documentation":"

A container for filter information for the selection of S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

" + "documentation":"

A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

" } }, - "documentation":"

A container for filters that define which source objects should be replicated.

" + "documentation":"

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS).

" }, "SseKmsEncryptedObjects":{ "type":"structure", @@ -7750,7 +7804,7 @@ "members":{ "Status":{ "shape":"SseKmsEncryptedObjectsStatus", - "documentation":"

If the status is not Enabled, replication for S3 objects encrypted with AWS KMS is disabled.

" + "documentation":"

Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS-managed key.

" } }, "documentation":"

A container for filter information for the selection of S3 objects encrypted with AWS KMS.

" @@ -7810,10 +7864,10 @@ "members":{ "DataExport":{ "shape":"StorageClassAnalysisDataExport", - "documentation":"

A container used to describe how data related to the storage class analysis should be exported.

" + "documentation":"

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

" } }, - "documentation":"

" + "documentation":"

Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.

" }, "StorageClassAnalysisDataExport":{ "type":"structure", @@ -7824,7 +7878,7 @@ "members":{ "OutputSchemaVersion":{ "shape":"StorageClassAnalysisSchemaVersion", - "documentation":"

The version of the output schema to use when exporting data. Must be V_1.

" + "documentation":"

The version of the output schema to use when exporting data. Must be V_1.

" }, "Destination":{ "shape":"AnalyticsExportDestination", @@ -7926,17 +7980,20 @@ "Id":{"shape":"NotificationId"}, "TopicArn":{ "shape":"TopicArn", - "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 will publish a message when it detects events of the specified type.

", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

", "locationName":"Topic" }, "Events":{ "shape":"EventList", - "documentation":"

", + "documentation":"

The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide.

", "locationName":"Event" }, - "Filter":{"shape":"NotificationConfigurationFilter"} + "Filter":{ + "shape":"NotificationConfigurationFilter", + "documentation":"

" + } }, - "documentation":"

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic.when Amazon S3 detects specified events.

" + "documentation":"

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

" }, "TopicConfigurationDeprecated":{ "type":"structure", @@ -7969,18 +8026,18 @@ "members":{ "Date":{ "shape":"Date", - "documentation":"

Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

" + "documentation":"

Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

" }, "Days":{ "shape":"Days", - "documentation":"

Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

" + "documentation":"

Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

" }, "StorageClass":{ "shape":"TransitionStorageClass", - "documentation":"

The class of storage used to store the object.

" + "documentation":"

The storage class to which you want the object to transition.

" } }, - "documentation":"

" + "documentation":"

Specifies when an object transitions to a specified storage class.

" }, "TransitionList":{ "type":"list", @@ -8233,7 +8290,7 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"

The base64-encoded 128-bit MD5 digest of the part data.

", + "documentation":"

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameted is required if object lock parameters are specified.

", "location":"header", "locationName":"Content-MD5" }, @@ -8303,29 +8360,29 @@ "documentation":"

The versioning state of the bucket.

" } }, - "documentation":"

" + "documentation":"

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon Simple Storage Service API Reference.

" }, "WebsiteConfiguration":{ "type":"structure", "members":{ "ErrorDocument":{ "shape":"ErrorDocument", - "documentation":"

" + "documentation":"

The name of the error document for the website.

" }, "IndexDocument":{ "shape":"IndexDocument", - "documentation":"

" + "documentation":"

The name of the index document for the website.

" }, "RedirectAllRequestsTo":{ "shape":"RedirectAllRequestsTo", - "documentation":"

" + "documentation":"

The redirect behavior for every request to this bucket's website endpoint.

If you specify this property, you can't specify any other property.

" }, "RoutingRules":{ "shape":"RoutingRules", - "documentation":"

" + "documentation":"

Rules that define when a redirect is applied and the redirect behavior.

" } }, - "documentation":"

" + "documentation":"

Specifies website configuration parameters for an Amazon S3 bucket.

" }, "WebsiteRedirectLocation":{"type":"string"}, "Years":{"type":"integer"} diff --git a/botocore/data/storagegateway/2013-06-30/service-2.json b/botocore/data/storagegateway/2013-06-30/service-2.json index 315c093891..e733c73321 100644 --- a/botocore/data/storagegateway/2013-06-30/service-2.json +++ b/botocore/data/storagegateway/2013-06-30/service-2.json @@ -994,6 +994,20 @@ ], "documentation":"

Updates a Server Message Block (SMB) file share.

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

" }, + "UpdateSMBSecurityStrategy":{ + "name":"UpdateSMBSecurityStrategy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSMBSecurityStrategyInput"}, + "output":{"shape":"UpdateSMBSecurityStrategyOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

" + }, "UpdateSnapshotSchedule":{ "name":"UpdateSnapshotSchedule", "http":{ @@ -2233,6 +2247,10 @@ "Tags":{ "shape":"Tags", "documentation":"

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

" + }, + "VPCEndpoint":{ + "shape":"string", + "documentation":"

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

" } }, "documentation":"

A JSON object containing the following fields:

" @@ -2332,6 +2350,10 @@ "SMBGuestPasswordSet":{ "shape":"Boolean", "documentation":"

This value is true if a password for the guest user “smbguest” is set, and otherwise false.

" + }, + "SMBSecurityStrategy":{ + "shape":"SMBSecurityStrategy", + "documentation":"

The type of security strategy that was specified for file gateway.

ClientSpecified: SMBv1 is enabled, SMB signing is offered but not required, SMB encryption is offered but not required.

MandatorySigning: SMBv1 is disabled, SMB signing is required, SMB encryption is offered but not required.

MandatoryEncryption: SMBv1 is disabled, SMB signing is offered but not required, SMB encryption is required.

" } } }, @@ -3690,6 +3712,14 @@ "pattern":"^[ -~]+$", "sensitive":true }, + "SMBSecurityStrategy":{ + "type":"string", + "enum":[ + "ClientSpecified", + "MandatorySigning", + "MandatoryEncryption" + ] + }, "ServiceUnavailableError":{ "type":"structure", "members":{ @@ -4381,6 +4411,26 @@ }, "documentation":"

UpdateSMBFileShareOutput

" }, + "UpdateSMBSecurityStrategyInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "SMBSecurityStrategy" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "SMBSecurityStrategy":{ + "shape":"SMBSecurityStrategy", + "documentation":"

Specifies the type of security strategy.

ClientSpecified: SMBv1 is enabled, SMB signing is offered but not required, SMB encryption is offered but not required.

MandatorySigning: SMBv1 is disabled, SMB signing is required, SMB encryption is offered but not required.

MandatoryEncryption: SMBv1 is disabled, SMB signing is offered but not required, SMB encryption is required.

" + } + } + }, + "UpdateSMBSecurityStrategyOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, "UpdateSnapshotScheduleInput":{ "type":"structure", "required":[ From 6822c36623feb9f07c5ad7799566db45fa10c0e9 Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Tue, 4 Jun 2019 18:24:29 +0000 Subject: [PATCH 2/3] Update to latest endpoints --- botocore/data/endpoints.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 99683fcb42..96f0a15ab7 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -442,6 +442,16 @@ "us-west-2" : { } } }, + "backup" : { + "endpoints" : { + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "batch" : { "endpoints" : { "ap-northeast-1" : { }, From 264536ae3b2fd0c7e7ccf63ca6f02972919bc28d Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Tue, 4 Jun 2019 18:24:29 +0000 Subject: [PATCH 3/3] Bumping version to 1.12.161 --- .changes/1.12.161.json | 27 +++++++++++++++++++ .../next-release/api-change-ec2-91509.json | 5 ---- .../api-change-elasticache-42182.json | 5 ---- .changes/next-release/api-change-iam-45.json | 5 ---- .../next-release/api-change-s3-15004.json | 5 ---- .../api-change-storagegateway-89542.json | 5 ---- CHANGELOG.rst | 10 +++++++ botocore/__init__.py | 2 +- docs/source/conf.py | 2 +- 9 files changed, 39 insertions(+), 27 deletions(-) create mode 100644 .changes/1.12.161.json delete mode 100644 .changes/next-release/api-change-ec2-91509.json delete mode 100644 .changes/next-release/api-change-elasticache-42182.json delete mode 100644 .changes/next-release/api-change-iam-45.json delete mode 100644 .changes/next-release/api-change-s3-15004.json delete mode 100644 .changes/next-release/api-change-storagegateway-89542.json diff --git a/.changes/1.12.161.json b/.changes/1.12.161.json new file mode 100644 index 0000000000..b50be7aa62 --- /dev/null +++ b/.changes/1.12.161.json @@ -0,0 +1,27 @@ +[ + { + "category": "``ec2``", + "description": "Update ec2 client to latest version", + "type": "api-change" + }, + { + "category": "``storagegateway``", + "description": "Update storagegateway client to latest version", + "type": "api-change" + }, + { + "category": "``s3``", + "description": "Update s3 client to latest version", + "type": "api-change" + }, + { + "category": "``elasticache``", + "description": "Update elasticache client to latest version", + "type": "api-change" + }, + { + "category": "``iam``", + "description": "Update iam client to latest version", + "type": "api-change" + } +] \ No newline at end of file diff --git a/.changes/next-release/api-change-ec2-91509.json b/.changes/next-release/api-change-ec2-91509.json deleted file mode 100644 index c936aeaa44..0000000000 --- a/.changes/next-release/api-change-ec2-91509.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "category": "``ec2``", - "type": "api-change", - "description": "Update ec2 client to latest version" -} diff --git a/.changes/next-release/api-change-elasticache-42182.json b/.changes/next-release/api-change-elasticache-42182.json deleted file mode 100644 index 54225ca06f..0000000000 --- a/.changes/next-release/api-change-elasticache-42182.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "category": "``elasticache``", - "type": "api-change", - "description": "Update elasticache client to latest version" -} diff --git a/.changes/next-release/api-change-iam-45.json b/.changes/next-release/api-change-iam-45.json deleted file mode 100644 index e66d971cb7..0000000000 --- a/.changes/next-release/api-change-iam-45.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "category": "``iam``", - "type": "api-change", - "description": "Update iam client to latest version" -} diff --git a/.changes/next-release/api-change-s3-15004.json b/.changes/next-release/api-change-s3-15004.json deleted file mode 100644 index 0f386d16c8..0000000000 --- a/.changes/next-release/api-change-s3-15004.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "category": "``s3``", - "type": "api-change", - "description": "Update s3 client to latest version" -} diff --git a/.changes/next-release/api-change-storagegateway-89542.json b/.changes/next-release/api-change-storagegateway-89542.json deleted file mode 100644 index b1660a7026..0000000000 --- a/.changes/next-release/api-change-storagegateway-89542.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "category": "``storagegateway``", - "type": "api-change", - "description": "Update storagegateway client to latest version" -} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ba9a5ca584..fd5d554a30 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,16 @@ CHANGELOG ========= +1.12.161 +======== + +* api-change:``ec2``: Update ec2 client to latest version +* api-change:``storagegateway``: Update storagegateway client to latest version +* api-change:``s3``: Update s3 client to latest version +* api-change:``elasticache``: Update elasticache client to latest version +* api-change:``iam``: Update iam client to latest version + + 1.12.160 ======== diff --git a/botocore/__init__.py b/botocore/__init__.py index 2f8dcd6174..c0319c9e97 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import re import logging -__version__ = '1.12.160' +__version__ = '1.12.161' class NullHandler(logging.Handler): diff --git a/docs/source/conf.py b/docs/source/conf.py index fe1484de03..7a01db3c93 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ # The short X.Y version. version = '1.12.1' # The full version, including alpha/beta/rc tags. -release = '1.12.160' +release = '1.12.161' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.