From ae9b9fd92af132cfd8d879809d8611825ba135f4 Mon Sep 17 00:00:00 2001 From: awssdkgo Date: Fri, 7 Aug 2020 22:37:56 +0000 Subject: [PATCH] Release v1.34.0 (2020-08-07) === ### Service Client Updates * `service/glue`: Updates service API and documentation * AWS Glue now adds support for Network connection type enabling you to access resources inside your VPC using Glue crawlers and Glue ETL jobs. * `service/organizations`: Updates service API and documentation * Documentation updates for some new error reasons. * `service/s3`: Updates service documentation and examples * Updates Amazon S3 API reference documentation. * `service/sms`: Updates service API and documentation * In this release, AWS Server Migration Service (SMS) has added new features: 1. APIs to work with application and instance level validation 2. Import application catalog from AWS Application Discovery Service 3. For an application you can start on-demand replication ### SDK Features * `service/s3/s3crypto`: Updates to the Amazon S3 Encryption Client - This change includes fixes for issues that were reported by Sophie Schmieg from the Google ISE team, and for issues that were discovered by AWS Cryptography. --- CHANGELOG.md | 16 + CHANGELOG_PENDING.md | 1 - aws/endpoints/defaults.go | 14 + aws/version.go | 2 +- models/apis/glue/2017-03-31/api-2.json | 6 +- models/apis/glue/2017-03-31/docs-2.json | 5 +- .../apis/organizations/2016-11-28/api-2.json | 4 +- .../apis/organizations/2016-11-28/docs-2.json | 2 +- models/apis/s3/2006-03-01/docs-2.json | 192 +- models/apis/s3/2006-03-01/examples-1.json | 208 +- models/apis/sms/2016-10-24/api-2.json | 423 ++- models/apis/sms/2016-10-24/docs-2.json | 613 +++-- models/endpoints/endpoints.json | 14 + service/glue/api.go | 16 + service/organizations/api.go | 15 + service/s3/api.go | 668 ++--- service/s3/examples_test.go | 184 +- service/s3/s3manager/upload_input.go | 2 +- service/sms/api.go | 2447 +++++++++++++++-- service/sms/doc.go | 18 +- service/sms/errors.go | 8 + service/sms/smsiface/interface.go | 28 + 22 files changed, 3850 insertions(+), 1036 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a87e58310d..5b02a435748 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +Release v1.34.0 (2020-08-07) +=== + +### Service Client Updates +* `service/glue`: Updates service API and documentation + * AWS Glue now adds support for Network connection type enabling you to access resources inside your VPC using Glue crawlers and Glue ETL jobs. +* `service/organizations`: Updates service API and documentation + * Documentation updates for some new error reasons. +* `service/s3`: Updates service documentation and examples + * Updates Amazon S3 API reference documentation. +* `service/sms`: Updates service API and documentation + * In this release, AWS Server Migration Service (SMS) has added new features: 1. APIs to work with application and instance level validation 2. Import application catalog from AWS Application Discovery Service 3. For an application you can start on-demand replication + +### SDK Features +* `service/s3/s3crypto`: Updates to the Amazon S3 Encryption Client - This change includes fixes for issues that were reported by Sophie Schmieg from the Google ISE team, and for issues that were discovered by AWS Cryptography. + Release v1.33.21 (2020-08-06) === diff --git a/CHANGELOG_PENDING.md b/CHANGELOG_PENDING.md index 3dd2eaebad1..8a1927a39ca 100644 --- a/CHANGELOG_PENDING.md +++ b/CHANGELOG_PENDING.md @@ -1,5 +1,4 @@ ### SDK Features -* `service/s3/s3crypto`: Updates to the Amazon S3 Encryption Client - This change includes fixes for issues that were reported by Sophie Schmieg from the Google ISE team, and for issues that were discovered by AWS Cryptography. ### SDK Enhancements diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 829923c28cc..4f9de24fd56 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -2084,6 +2084,7 @@ var awsPartition = partition{ Protocols: []string{"http", "https"}, }, Endpoints: endpoints{ + "af-south-1": endpoint{}, "ap-east-1": endpoint{}, "ap-northeast-1": endpoint{}, "ap-northeast-2": endpoint{}, @@ -2093,6 +2094,7 @@ var awsPartition = partition{ "ca-central-1": endpoint{}, "eu-central-1": endpoint{}, "eu-north-1": endpoint{}, + "eu-south-1": endpoint{}, "eu-west-1": endpoint{}, "eu-west-2": endpoint{}, "eu-west-3": endpoint{}, @@ -3959,6 +3961,12 @@ var awsPartition = partition{ "neptune": service{ Endpoints: endpoints{ + "ap-east-1": endpoint{ + Hostname: "rds.ap-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "ap-east-1", + }, + }, "ap-northeast-1": endpoint{ Hostname: "rds.ap-northeast-1.amazonaws.com", CredentialScope: credentialScope{ @@ -4031,6 +4039,12 @@ var awsPartition = partition{ Region: "me-south-1", }, }, + "sa-east-1": endpoint{ + Hostname: "rds.sa-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "sa-east-1", + }, + }, "us-east-1": endpoint{ Hostname: "rds.us-east-1.amazonaws.com", CredentialScope: credentialScope{ diff --git a/aws/version.go b/aws/version.go index c3b5b8db296..08127d60d4c 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.33.21" +const SDKVersion = "1.34.0" diff --git a/models/apis/glue/2017-03-31/api-2.json b/models/apis/glue/2017-03-31/api-2.json index 531ec633973..31881cf9d52 100644 --- a/models/apis/glue/2017-03-31/api-2.json +++ b/models/apis/glue/2017-03-31/api-2.json @@ -2772,7 +2772,8 @@ "JDBC", "SFTP", "MONGODB", - "KAFKA" + "KAFKA", + "NETWORK" ] }, "ConnectionsList":{ @@ -5679,7 +5680,8 @@ "type":"structure", "members":{ "Path":{"shape":"Path"}, - "Exclusions":{"shape":"PathList"} + "Exclusions":{"shape":"PathList"}, + "ConnectionName":{"shape":"ConnectionName"} } }, "S3TargetList":{ diff --git a/models/apis/glue/2017-03-31/docs-2.json b/models/apis/glue/2017-03-31/docs-2.json index 576beff8749..fd7a094a847 100644 --- a/models/apis/glue/2017-03-31/docs-2.json +++ b/models/apis/glue/2017-03-31/docs-2.json @@ -766,7 +766,8 @@ "ConnectionName": { "base": null, "refs": { - "JdbcTarget$ConnectionName": "

The name of the connection to use to connect to the JDBC target.

" + "JdbcTarget$ConnectionName": "

The name of the connection to use to connect to the JDBC target.

", + "S3Target$ConnectionName": "

The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

" } }, "ConnectionPasswordEncryption": { @@ -792,7 +793,7 @@ "base": null, "refs": { "Connection$ConnectionType": "

The type of the connection. Currently, SFTP is not supported.

", - "ConnectionInput$ConnectionType": "

The type of the connection. Currently, these types are supported:

SFTP is not supported.

", + "ConnectionInput$ConnectionType": "

The type of the connection. Currently, these types are supported:

SFTP is not supported.

", "GetConnectionsFilter$ConnectionType": "

The type of connections to return. Currently, SFTP is not supported.

" } }, diff --git a/models/apis/organizations/2016-11-28/api-2.json b/models/apis/organizations/2016-11-28/api-2.json index bc5f73cb0ba..505932911b7 100644 --- a/models/apis/organizations/2016-11-28/api-2.json +++ b/models/apis/organizations/2016-11-28/api-2.json @@ -1208,7 +1208,9 @@ "INVALID_EMAIL", "CONCURRENT_ACCOUNT_MODIFICATION", "INTERNAL_FAILURE", - "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" + "GOVCLOUD_ACCOUNT_ALREADY_EXISTS", + "MISSING_BUSINESS_VALIDATION", + "MISSING_PAYMENT_INSTRUMENT" ] }, "CreateAccountRequest":{ diff --git a/models/apis/organizations/2016-11-28/docs-2.json b/models/apis/organizations/2016-11-28/docs-2.json index 0134559a724..9160d1a7ba4 100644 --- a/models/apis/organizations/2016-11-28/docs-2.json +++ b/models/apis/organizations/2016-11-28/docs-2.json @@ -251,7 +251,7 @@ "CreateAccountFailureReason": { "base": null, "refs": { - "CreateAccountStatus$FailureReason": "

If the request failed, a description of the reason for the failure.

" + "CreateAccountStatus$FailureReason": "

If the request failed, a description of the reason for the failure.

" } }, "CreateAccountRequest": { diff --git a/models/apis/s3/2006-03-01/docs-2.json b/models/apis/s3/2006-03-01/docs-2.json index dd55651a045..c174ed654ed 100644 --- a/models/apis/s3/2006-03-01/docs-2.json +++ b/models/apis/s3/2006-03-01/docs-2.json @@ -2,94 +2,94 @@ "version": "2.0", "service": "

", "operations": { - "AbortMultipartUpload": "

This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to AbortMultipartUpload:

", - "CompleteMultipartUpload": "

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

GetBucketLifecycle has the following special errors:

The following operations are related to CompleteMultipartUpload:

", - "CopyObject": "

Creates a copy of an object that is already stored in Amazon S3.

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.

If the copy is successful, you receive a response with information about the copied object.

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.

The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.

Metadata

When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.

To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

x-amz-copy-source-if Headers

To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters:

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.

Encryption

The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it.

You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.

Access Control List (ACL)-Specific Request Headers

When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

Storage Class Options

You can use the CopyObject operation to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Versioning

By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.

If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see .

The following operations are related to CopyObject:

For more information, see Copying Objects.

", - "CreateBucket": "

Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see How to Select a Region for Your Buckets.

If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual Hosting of Buckets.

When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

The following operations are related to CreateBucket:

", - "CreateMultipartUpload": "

This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.

For more information about multipart uploads, see Multipart Upload Overview.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).

After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.

You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart) and UploadPartCopy) requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.

To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, and kms:DescribeKey actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption.

Access Permissions

When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

  • Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers

You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.

  • Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.

    • x-amz-server-side​-encryption

    • x-amz-server-side-encryption-aws-kms-key-id

    • x-amz-server-side-encryption-context

    If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.

    All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.

    For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

  • Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.

    • x-amz-server-side​-encryption​-customer-algorithm

    • x-amz-server-side​-encryption​-customer-key

    • x-amz-server-side​-encryption​-customer-key-MD5

    For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

Access-Control-List (ACL)-Specific Request Headers

You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:

  • Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:

    • x-amz-grant-read

    • x-amz-grant-write

    • x-amz-grant-read-acp

    • x-amz-grant-write-acp

    • x-amz-grant-full-control

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an AWS account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an AWS account

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

    For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

    x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"

The following operations are related to CreateMultipartUpload:

", - "DeleteBucket": "

Deletes the bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Related Resources

", - "DeleteBucketAnalyticsConfiguration": "

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. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to DeleteBucketAnalyticsConfiguration:

", - "DeleteBucketCors": "

Deletes the cors configuration information set for the bucket.

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

For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

Related Resources:

", - "DeleteBucketEncryption": "

This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Related Resources

", - "DeleteBucketInventoryConfiguration": "

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

Operations related to DeleteBucketInventoryConfiguration include:

", - "DeleteBucketLifecycle": "

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

", - "DeleteBucketMetricsConfiguration": "

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to DeleteBucketMetricsConfiguration:

", - "DeleteBucketPolicy": "

This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and UserPolicies.

The following operations are related to DeleteBucketPolicy

", - "DeleteBucketReplication": "

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication in the Amazon S3 Developer Guide.

The following operations are related to DeleteBucketReplication:

", - "DeleteBucketTagging": "

Deletes the tags from the bucket.

To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

The following operations are related to DeleteBucketTagging:

", - "DeleteBucketWebsite": "

This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE operation requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

", - "DeleteObject": "

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

The following operation is related to DeleteObject:

", - "DeleteObjectTagging": "

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteBucketMetricsConfiguration:

", - "DeleteObjects": "

This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.

When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.

The following operations are related to DeleteObjects:

", - "DeletePublicAccessBlock": "

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to DeletePublicAccessBlock:

", - "GetBucketAccelerateConfiguration": "

This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.

Related Resources

", - "GetBucketAcl": "

This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

Related Resources

", - "GetBucketAnalyticsConfiguration": "

This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide.

Related Resources

", - "GetBucketCors": "

Returns the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

For more information about cors, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

", - "GetBucketEncryption": "

Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to GetBucketEncryption:

", - "GetBucketInventoryConfiguration": "

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

", - "GetBucketLifecycle": "

For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycle has the following special error:

The following operations are related to GetBucketLifecycle:

", - "GetBucketLifecycleConfiguration": "

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are still using previous version of the lifecycle configuration, it works. For the earlier API description, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycleConfiguration has the following special error:

The following operations are related to GetBucketLifecycleConfiguration:

", - "GetBucketLocation": "

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

To use this implementation of the operation, you must be the bucket owner.

The following operations are related to GetBucketLocation:

", - "GetBucketLogging": "

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

The following operations are related to GetBucketLogging:

", - "GetBucketMetricsConfiguration": "

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

", - "GetBucketNotification": "

No longer used, see GetBucketNotificationConfiguration.

", - "GetBucketNotificationConfiguration": "

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following operation is related to GetBucketNotification:

", - "GetBucketPolicy": "

Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

The following operation is related to GetBucketPolicy:

", - "GetBucketPolicyStatus": "

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".

The following operations are related to GetBucketPolicyStatus:

", - "GetBucketReplication": "

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.

This operation requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

For information about GetBucketReplication errors, see ReplicationErrorCodeList

The following operations are related to GetBucketReplication:

", - "GetBucketRequestPayment": "

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

", - "GetBucketTagging": "

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

The following operations are related to GetBucketTagging:

", - "GetBucketVersioning": "

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

", - "GetBucketWebsite": "

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.

This GET operation requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

The following operations are related to DeleteBucketWebsite:

", - "GetObject": "

Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.

To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.

To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging action), the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

Permissions

You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

Versioning

By default, the GET operation returns the current version of an object. To return a different version, use the versionId subresource.

If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

For more information about versioning, see PutBucketVersioning.

Overriding Response Header Values

There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.

You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.

You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.

Additional Considerations about Request Headers

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

The following operations are related to GetObject:

", - "GetObjectAcl": "

Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.

Versioning

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

The following operations are related to GetObjectAcl:

", + "AbortMultipartUpload": "

This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to AbortMultipartUpload:

", + "CompleteMultipartUpload": "

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload.

For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

CompleteMultipartUpload has the following special errors:

The following operations are related to CompleteMultipartUpload:

", + "CopyObject": "

Creates a copy of an object that is already stored in Amazon S3.

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.

If the copy is successful, you receive a response with information about the copied object.

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.

The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.

Metadata

When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.

To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

x-amz-copy-source-if Headers

To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters:

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.

Encryption

The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it.

You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.

Access Control List (ACL)-Specific Request Headers

When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

Storage Class Options

You can use the CopyObject operation to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Versioning

By default, x-amz-copy-source identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.

If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.

The following operations are related to CopyObject:

For more information, see Copying Objects.

", + "CreateBucket": "

Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see How to Select a Region for Your Buckets.

If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual Hosting of Buckets.

When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

The following operations are related to CreateBucket:

", + "CreateMultipartUpload": "

This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.

For more information about multipart uploads, see Multipart Upload Overview.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).

After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.

You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload.

To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, and kms:DescribeKey actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption.

Access Permissions

When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

  • Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.

  • Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers

You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.

  • Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.

    • x-amz-server-side-encryption

    • x-amz-server-side-encryption-aws-kms-key-id

    • x-amz-server-side-encryption-context

    If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.

    All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.

    For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

  • Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.

    • x-amz-server-side-encryption-customer-algorithm

    • x-amz-server-side-encryption-customer-key

    • x-amz-server-side-encryption-customer-key-MD5

    For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.

Access-Control-List (ACL)-Specific Request Headers

You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:

  • Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:

    • x-amz-grant-read

    • x-amz-grant-write

    • x-amz-grant-read-acp

    • x-amz-grant-write-acp

    • x-amz-grant-full-control

    You specify each grantee as a type=value pair, where the type is one of the following:

    • id – if the value specified is the canonical user ID of an AWS account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an AWS account

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

    For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

    x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"

The following operations are related to CreateMultipartUpload:

", + "DeleteBucket": "

Deletes the bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Related Resources

", + "DeleteBucketAnalyticsConfiguration": "

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. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to DeleteBucketAnalyticsConfiguration:

", + "DeleteBucketCors": "

Deletes the cors configuration information set for the bucket.

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

For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

Related Resources:

", + "DeleteBucketEncryption": "

This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Related Resources

", + "DeleteBucketInventoryConfiguration": "

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

Operations related to DeleteBucketInventoryConfiguration include:

", + "DeleteBucketLifecycle": "

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

", + "DeleteBucketMetricsConfiguration": "

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to DeleteBucketMetricsConfiguration:

", + "DeleteBucketPolicy": "

This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and UserPolicies.

The following operations are related to DeleteBucketPolicy

", + "DeleteBucketReplication": "

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication in the Amazon S3 Developer Guide.

The following operations are related to DeleteBucketReplication:

", + "DeleteBucketTagging": "

Deletes the tags from the bucket.

To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

The following operations are related to DeleteBucketTagging:

", + "DeleteBucketWebsite": "

This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE operation requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

", + "DeleteObject": "

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

The following operation is related to DeleteObject:

", + "DeleteObjectTagging": "

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteBucketMetricsConfiguration:

", + "DeleteObjects": "

This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.

When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.

The following operations are related to DeleteObjects:

", + "DeletePublicAccessBlock": "

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to DeletePublicAccessBlock:

", + "GetBucketAccelerateConfiguration": "

This implementation of the GET operation uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.

Related Resources

", + "GetBucketAcl": "

This implementation of the GET operation uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

Related Resources

", + "GetBucketAnalyticsConfiguration": "

This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide.

Related Resources

", + "GetBucketCors": "

Returns the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

For more information about cors, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

", + "GetBucketEncryption": "

Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to GetBucketEncryption:

", + "GetBucketInventoryConfiguration": "

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

", + "GetBucketLifecycle": "

For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycle has the following special error:

The following operations are related to GetBucketLifecycle:

", + "GetBucketLifecycleConfiguration": "

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are still using previous version of the lifecycle configuration, it works. For the earlier API description, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycleConfiguration has the following special error:

The following operations are related to GetBucketLifecycleConfiguration:

", + "GetBucketLocation": "

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

To use this implementation of the operation, you must be the bucket owner.

The following operations are related to GetBucketLocation:

", + "GetBucketLogging": "

Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

The following operations are related to GetBucketLogging:

", + "GetBucketMetricsConfiguration": "

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

", + "GetBucketNotification": "

No longer used, see GetBucketNotificationConfiguration.

", + "GetBucketNotificationConfiguration": "

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following operation is related to GetBucketNotification:

", + "GetBucketPolicy": "

Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

The following operation is related to GetBucketPolicy:

", + "GetBucketPolicyStatus": "

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".

The following operations are related to GetBucketPolicyStatus:

", + "GetBucketReplication": "

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.

This operation requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

For information about GetBucketReplication errors, see List of replication-related error codes

The following operations are related to GetBucketReplication:

", + "GetBucketRequestPayment": "

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

", + "GetBucketTagging": "

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

The following operations are related to GetBucketTagging:

", + "GetBucketVersioning": "

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

", + "GetBucketWebsite": "

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.

This GET operation requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

The following operations are related to DeleteBucketWebsite:

", + "GetObject": "

Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.

To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.

To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectStateError error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging action), the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

Permissions

You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

Versioning

By default, the GET operation returns the current version of an object. To return a different version, use the versionId subresource.

If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

For more information about versioning, see PutBucketVersioning.

Overriding Response Header Values

There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.

You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.

You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.

Additional Considerations about Request Headers

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

The following operations are related to GetObject:

", + "GetObjectAcl": "

Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP access to the object.

Versioning

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

The following operations are related to GetObjectAcl:

", "GetObjectLegalHold": "

Gets an object's current Legal Hold status. For more information, see Locking Objects.

", "GetObjectLockConfiguration": "

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. For more information, see Locking Objects.

", "GetObjectRetention": "

Retrieves an object's retention settings. For more information, see Locking Objects.

", - "GetObjectTagging": "

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following operation is related to GetObjectTagging:

", - "GetObjectTorrent": "

Return torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Amazon S3 Torrent.

You can get torrent only for objects that are less than 5 GB in size and that are not encrypted using server-side encryption with customer-provided encryption key.

To use GET, you must have READ access to the object.

The following operation is related to GetObjectTorrent:

", - "GetPublicAccessBlock": "

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

The following operations are related to GetPublicAccessBlock:

", + "GetObjectTagging": "

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following operation is related to GetObjectTagging:

", + "GetObjectTorrent": "

Return torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Amazon S3 Torrent.

You can get torrent only for objects that are less than 5 GB in size and that are not encrypted using server-side encryption with customer-provided encryption key.

To use GET, you must have READ access to the object.

The following operation is related to GetObjectTorrent:

", + "GetPublicAccessBlock": "

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

The following operations are related to GetPublicAccessBlock:

", "HeadBucket": "

This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a 200 OK if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as 404 Not Found and 403 Forbidden.

To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

", - "HeadObject": "

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Consider the following when using request headers:

For more information about conditional requests, see RFC 7232.

Permissions

You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

The following operation is related to HeadObject:

", - "ListBucketAnalyticsConfigurations": "

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

", - "ListBucketInventoryConfigurations": "

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

", - "ListBucketMetricsConfigurations": "

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

", + "HeadObject": "

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Consider the following when using request headers:

For more information about conditional requests, see RFC 7232.

Permissions

You need the s3:GetObject permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

The following operation is related to HeadObject:

", + "ListBucketAnalyticsConfigurations": "

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

", + "ListBucketInventoryConfigurations": "

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

", + "ListBucketMetricsConfigurations": "

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

", "ListBuckets": "

Returns a list of all buckets owned by the authenticated sender of the request.

", - "ListMultipartUploads": "

This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to ListMultipartUploads:

", - "ListObjectVersions": "

Returns metadata about all of the versions of objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

The following operations are related to ListObjectVersions:

", - "ListObjects": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

", - "ListObjectsV2": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

", - "ListParts": "

Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to ListParts:

", - "PutBucketAccelerateConfiguration": "

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

", - "PutBucketAcl": "

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

Access Permissions

You can set access permissions using one of the following methods:

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Related Resources

", - "PutBucketAnalyticsConfiguration": "

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

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. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

Special Errors

Related Resources

", - "PutBucketCors": "

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

Related Resources

", - "PutBucketEncryption": "

This implementation of the PUT operation uses the encryption subresource to set the default encryption state of an existing bucket.

This implementation of the PUT operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Related Resources

", - "PutBucketInventoryConfiguration": "

This implementation of the PUT operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Special Errors

Related Resources

", - "PutBucketLifecycle": "

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

Related Resources

", - "PutBucketLifecycleConfiguration": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

The following are related to PutBucketLifecycleConfiguration:

", - "PutBucketLogging": "

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" />

For more information about server access logging, see Server Access Logging.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

", - "PutBucketMetricsConfiguration": "

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per 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.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

GetBucketLifecycle has the following special error:

", - "PutBucketNotification": "

No longer used, see the PutBucketNotificationConfiguration operation.

", - "PutBucketNotificationConfiguration": "

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This operation replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.

Responses

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following operation is related to PutBucketNotificationConfiguration:

", - "PutBucketPolicy": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

The following operations are related to PutBucketPolicy:

", - "PutBucketReplication": "

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.

To perform this operation, the user or role performing the operation must have the iam:PassRole permission.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.

To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

For information about enabling versioning on a bucket, see Using Versioning.

By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.

For information on PutBucketReplication errors, see ReplicationErrorCodeList

The following operations are related to PutBucketReplication:

", - "PutBucketRequestPayment": "

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

", - "PutBucketTagging": "

Sets the tags for a bucket.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketTagging has the following special errors:

The following operations are related to PutBucketTagging:

", - "PutBucketVersioning": "

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

Related Resources

", + "ListMultipartUploads": "

This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to ListMultipartUploads:

", + "ListObjectVersions": "

Returns metadata about all of the versions of objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

The following operations are related to ListObjectVersions:

", + "ListObjects": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

", + "ListObjectsV2": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

", + "ListParts": "

Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.

The following operations are related to ListParts:

", + "PutBucketAccelerateConfiguration": "

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

The GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

", + "PutBucketAcl": "

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

Access Permissions

You can set access permissions using one of the following methods:

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Related Resources

", + "PutBucketAnalyticsConfiguration": "

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

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. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

Special Errors

Related Resources

", + "PutBucketCors": "

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

Related Resources

", + "PutBucketEncryption": "

This implementation of the PUT operation uses the encryption subresource to set the default encryption state of an existing bucket.

This implementation of the PUT operation sets default encryption for a bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Related Resources

", + "PutBucketInventoryConfiguration": "

This implementation of the PUT operation adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Special Errors

Related Resources

", + "PutBucketLifecycle": "

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

Related Resources

", + "PutBucketLifecycleConfiguration": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

The following are related to PutBucketLifecycleConfiguration:

", + "PutBucketLogging": "

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" />

For more information about server access logging, see Server Access Logging.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

", + "PutBucketMetricsConfiguration": "

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per 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.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

GetBucketLifecycle has the following special error:

", + "PutBucketNotification": "

No longer used, see the PutBucketNotificationConfiguration operation.

", + "PutBucketNotificationConfiguration": "

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This operation replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.

Responses

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following operation is related to PutBucketNotificationConfiguration:

", + "PutBucketPolicy": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

The following operations are related to PutBucketPolicy:

", + "PutBucketReplication": "

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.

To perform this operation, the user or role performing the operation must have the iam:PassRole permission.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.

To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that contain the Filter element for rules, and rules that specify S3 Replication Time Control (S3 RTC). In XML V2 replication configurations, Amazon S3 doesn't replicate delete markers. Therefore, you must set the DeleteMarkerReplication element to Disabled. For backward compatibility, Amazon S3 continues to support the XML V1 replication configuration.

For information about enabling versioning on a bucket, see Using Versioning.

By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.

For information on PutBucketReplication errors, see List of replication-related error codes

The following operations are related to PutBucketReplication:

", + "PutBucketRequestPayment": "

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

", + "PutBucketTagging": "

Sets the tags for a bucket.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketTagging has the following special errors:

The following operations are related to PutBucketTagging:

", + "PutBucketVersioning": "

Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

Related Resources

", "PutBucketWebsite": "

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.

This PUT operation requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission.

To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.

If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon Simple Storage Service Developer Guide.

", - "PutObject": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon Simple Storage Service Developer Guide.

Server-side Encryption

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption.

Access Control List (ACL)-Specific Request Headers

You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

Storage Class Options

By default, Amazon S3 uses the STANDARD storage class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different storage class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Versioning

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.

For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.

Related Resources

", - "PutObjectAcl": "

Uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have WRITE_ACP permission to set the ACL of an object.

Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 Developer Guide.

Access Permissions

You can set access permissions using one of the following methods:

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Versioning

The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

Related Resources

", + "PutObject": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon Simple Storage Service Developer Guide.

Server-side Encryption

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption.

Access Control List (ACL)-Specific Request Headers

You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

Storage Class Options

By default, Amazon S3 uses the STANDARD storage class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different storage class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Versioning

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.

For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.

Related Resources

", + "PutObjectAcl": "

Uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have WRITE_ACP permission to set the ACL of an object.

Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 Developer Guide.

Access Permissions

You can set access permissions using one of the following methods:

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

Versioning

The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.

Related Resources

", "PutObjectLegalHold": "

Applies a Legal Hold configuration to the specified object.

Related Resources

", "PutObjectLockConfiguration": "

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.

DefaultRetention requires either Days or Years. You can't specify both at the same time.

Related Resources

", "PutObjectRetention": "

Places an Object Retention configuration on an object.

Related Resources

", - "PutObjectTagging": "

Sets the supplied tag-set to an object that already exists in a bucket.

A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

For information about the Amazon S3 object tagging feature, see Object Tagging.

Special Errors

Related Resources

", - "PutPublicAccessBlock": "

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

Related Resources

", - "RestoreObject": "

Restores an archived copy of an object back into Amazon S3

This operation performs the following types of requests:

  • select - Perform a select query on an archived object

  • restore an archive - Restore an archived object

To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Querying Archives with Select Requests

You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.

When making a select request, do the following:

  • Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.

    For more information about the S3 structure in the request body, see the following:

  • Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples.

    • The following expression returns all records from the specified object.

      SELECT * FROM Object

    • Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.

      SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

    • If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.

      SELECT s.Id, s.FirstName, s.SSN FROM S3Object s

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

When making a select request, you can also do the following:

  • To expedite your queries, specify the Expedited tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.

  • Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.

The following are additional important facts about the select feature:

  • The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.

  • You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.

  • Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.

Restoring Archives

Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from.

To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.

The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify.

When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body:

  • Expedited - Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class.

  • Standard - S3 Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. S3 Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class.

  • Bulk - Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new Tier request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the Days request element. For more information, see Upgrading the Speed of an In-Progress Restore in the Amazon Simple Storage Service Developer Guide.

To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon Simple Storage Service Developer Guide.

After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.

If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon Simple Storage Service Developer Guide.

Responses

A successful operation returns either the 200 OK or 202 Accepted status code.

  • If the object copy is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object copy is previously restored, Amazon S3 returns 200 OK in the response.

Special Errors

    • Code: RestoreAlreadyInProgress

    • Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)

    • HTTP Status Code: 409 Conflict

    • SOAP Fault Code Prefix: Client

    • Code: GlacierExpeditedRetrievalNotAvailable

    • Cause: S3 Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)

    • HTTP Status Code: 503

    • SOAP Fault Code Prefix: N/A

Related Resources

", - "SelectObjectContent": "

This operation filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

For more information about Amazon S3 Select, see Selecting Content from Objects in the Amazon Simple Storage Service Developer Guide.

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

Permissions

You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon Simple Storage Service Developer Guide.

Object Data Formats

You can use Amazon S3 Select to query objects that have the following format properties:

  • CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.

  • UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.

  • Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon Simple Storage Service Developer Guide.

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide.

Working with the Response Body

Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see RESTSelectObjectAppendix .

GetObject Support

The SelectObjectContent operation does not support the following GetObject functionality. For more information, see GetObject.

  • Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest$ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.

  • GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon Simple Storage Service Developer Guide.

Special Errors

For a list of special errors for this operation, see SelectObjectContentErrorCodeList

Related Resources

", - "UploadPart": "

Uploads a part in a multipart upload.

In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.

You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.

To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

For more information on multipart uploads, go to Multipart Upload Overview in the Amazon Simple Storage Service Developer Guide .

For information on the permissions required to use the multipart upload API, go to Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.

You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide.

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.

If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.

  • x-amz-server-side​-encryption​-customer-algorithm

  • x-amz-server-side​-encryption​-customer-key

  • x-amz-server-side​-encryption​-customer-key-MD5

Special Errors

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

Related Resources

", - "UploadPartCopy": "

Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.

The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon Simple Storage Service Developer Guide.

Instead of using an existing object as part data, you might use the UploadPart operation and provide data in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.

For more information about using the UploadPartCopy operation, see the following:

  • For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon Simple Storage Service Developer Guide.

  • For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.

  • For information about copying objects using a single atomic operation vs. the multipart upload, see Operations on Objects in the Amazon Simple Storage Service Developer Guide.

  • For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since:

  • Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

    x-amz-copy-source-if-match condition evaluates to true, and;

    x-amz-copy-source-if-unmodified-since condition evaluates to false;

    Amazon S3 returns 200 OK and copies the data.

  • Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

    x-amz-copy-source-if-none-match condition evaluates to false, and;

    x-amz-copy-source-if-modified-since condition evaluates to true;

    Amazon S3 returns 412 Precondition Failed response code.

Versioning

If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example:

x-amz-copy-source: /bucket/object?versionId=version id

Special Errors

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • Code: InvalidRequest

    • Cause: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

Related Resources

" + "PutObjectTagging": "

Sets the supplied tag-set to an object that already exists in a bucket.

A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

For information about the Amazon S3 object tagging feature, see Object Tagging.

Special Errors

    • Code: InvalidTagError

    • Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging.

    • Code: MalformedXMLError

    • Cause: The XML provided does not match the schema.

    • Code: OperationAbortedError

    • Cause: A conflicting conditional operation is currently in progress against this resource. Please try again.

    • Code: InternalError

    • Cause: The service was unable to apply the provided tag to the object.

Related Resources

", + "PutPublicAccessBlock": "

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

Related Resources

", + "RestoreObject": "

Restores an archived copy of an object back into Amazon S3

This operation performs the following types of requests:

  • select - Perform a select query on an archived object

  • restore an archive - Restore an archived object

To use this operation, you must have permissions to perform the s3:RestoreObject action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

Querying Archives with Select Requests

You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.

When making a select request, do the following:

  • Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.

    For more information about the S3 structure in the request body, see the following:

  • Define the SQL expression for the SELECT type of restoration for your query in the request body's SelectParameters structure. You can use expressions like the following examples.

    • The following expression returns all records from the specified object.

      SELECT * FROM Object

    • Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.

      SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

    • If you have headers and you set the fileHeaderInfo in the CSV structure in the request body to USE, you can specify headers in the query. (If you set the fileHeaderInfo field to IGNORE, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.

      SELECT s.Id, s.FirstName, s.SSN FROM S3Object s

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

When making a select request, you can also do the following:

  • To expedite your queries, specify the Expedited tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.

  • Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.

The following are additional important facts about the select feature:

  • The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.

  • You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.

  • Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409.

Restoring Archives

Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from.

To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.

The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify.

When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier element of the request body:

  • Expedited - Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class.

  • Standard - S3 Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. S3 Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class.

  • Bulk - Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new Tier request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the Days request element. For more information, see Upgrading the Speed of an In-Progress Restore in the Amazon Simple Storage Service Developer Guide.

To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon Simple Storage Service Developer Guide.

After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.

If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon Simple Storage Service Developer Guide.

Responses

A successful operation returns either the 200 OK or 202 Accepted status code.

  • If the object copy is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object copy is previously restored, Amazon S3 returns 200 OK in the response.

Special Errors

    • Code: RestoreAlreadyInProgress

    • Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)

    • HTTP Status Code: 409 Conflict

    • SOAP Fault Code Prefix: Client

    • Code: GlacierExpeditedRetrievalNotAvailable

    • Cause: S3 Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)

    • HTTP Status Code: 503

    • SOAP Fault Code Prefix: N/A

Related Resources

", + "SelectObjectContent": "

This operation filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

For more information about Amazon S3 Select, see Selecting Content from Objects in the Amazon Simple Storage Service Developer Guide.

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

Permissions

You must have s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon Simple Storage Service Developer Guide.

Object Data Formats

You can use Amazon S3 Select to query objects that have the following format properties:

  • CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.

  • UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.

  • Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon Simple Storage Service Developer Guide.

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide.

Working with the Response Body

Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response .

GetObject Support

The SelectObjectContent operation does not support the following GetObject functionality. For more information, see GetObject.

  • Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.

  • GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For more information, about storage classes see Storage Classes in the Amazon Simple Storage Service Developer Guide.

Special Errors

For a list of special errors for this operation, see List of SELECT Object Content Error Codes

Related Resources

", + "UploadPart": "

Uploads a part in a multipart upload.

In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.

You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.

To ensure that data is not corrupted when traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

For more information on multipart uploads, go to Multipart Upload Overview in the Amazon Simple Storage Service Developer Guide .

For information on the permissions required to use the multipart upload API, go to Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.

You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide.

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.

If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

Special Errors

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

Related Resources

", + "UploadPartCopy": "

Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source in your request and a byte range by adding the request header x-amz-copy-source-range in your request.

The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon Simple Storage Service Developer Guide.

Instead of using an existing object as part data, you might use the UploadPart operation and provide data in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.

For more information about using the UploadPartCopy operation, see the following:

  • For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon Simple Storage Service Developer Guide.

  • For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.

  • For information about copying objects using a single atomic operation vs. the multipart upload, see Operations on Objects in the Amazon Simple Storage Service Developer Guide.

  • For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

Note the following additional considerations about the request headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since:

  • Consideration 1 - If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:

    x-amz-copy-source-if-match condition evaluates to true, and;

    x-amz-copy-source-if-unmodified-since condition evaluates to false;

    Amazon S3 returns 200 OK and copies the data.

  • Consideration 2 - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:

    x-amz-copy-source-if-none-match condition evaluates to false, and;

    x-amz-copy-source-if-modified-since condition evaluates to true;

    Amazon S3 returns 412 Precondition Failed response code.

Versioning

If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

You can optionally specify a specific version of the source object to copy by adding the versionId subresource as shown in the following example:

x-amz-copy-source: /bucket/object?versionId=version id

Special Errors

    • Code: NoSuchUpload

    • Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.

    • HTTP Status Code: 404 Not Found

    • Code: InvalidRequest

    • Cause: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

Related Resources

" }, "shapes": { "AbortDate": { @@ -1023,7 +1023,7 @@ "CopyPartResult$ETag": "

Entity tag of the object.

", "GetObjectOutput$ETag": "

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

", "HeadObjectOutput$ETag": "

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

", - "Object$ETag": "

The entity tag is an MD5 hash of the object. ETag reflects only changes to the contents of an object, not its metadata.

", + "Object$ETag": "

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

  • Objects created by the PUT Object, POST Object, or Copy operation, or through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

  • If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.

", "ObjectVersion$ETag": "

The entity tag is an MD5 hash of that version of the object.

", "Part$ETag": "

Entity tag returned when the part was uploaded.

", "PutObjectOutput$ETag": "

Entity tag for the uploaded object.

", @@ -1137,7 +1137,7 @@ "CopyObjectOutput$Expiration": "

If the object expiration is configured, the response includes this header.

", "GetObjectOutput$Expiration": "

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

", "HeadObjectOutput$Expiration": "

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

", - "PutObjectOutput$Expiration": "

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

" + "PutObjectOutput$Expiration": "

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.

" } }, "ExpirationStatus": { @@ -2206,7 +2206,7 @@ "NextMarker": { "base": null, "refs": { - "ListObjectsOutput$NextMarker": "

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

" + "ListObjectsOutput$NextMarker": "

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

" } }, "NextPartNumberMarker": { @@ -2346,7 +2346,7 @@ "CreateMultipartUploadRequest$Key": "

Object key for which the multipart upload is to be initiated.

", "DeleteMarkerEntry$Key": "

The object key.

", "DeleteObjectRequest$Key": "

Key name of the object to delete.

", - "DeleteObjectTaggingRequest$Key": "

Name of the tag.

", + "DeleteObjectTaggingRequest$Key": "

Name of the object key.

", "DeletedObject$Key": "

The name of the deleted object.

", "Error$Key": "

The error key.

", "ErrorDocument$Key": "

The object key name to use when a 4XX class error occurs.

", @@ -2367,10 +2367,10 @@ "PutObjectLegalHoldRequest$Key": "

The key name for the object that you want to place a Legal Hold on.

", "PutObjectRequest$Key": "

Object key for which the PUT operation was initiated.

", "PutObjectRetentionRequest$Key": "

The key name for the object that you want to apply this Object Retention configuration to.

", - "PutObjectTaggingRequest$Key": "

Name of the tag.

", + "PutObjectTaggingRequest$Key": "

Name of the object key.

", "RestoreObjectRequest$Key": "

Object key for which the operation was initiated.

", "SelectObjectContentRequest$Key": "

The object key.

", - "Tag$Key": "

Name of the tag.

", + "Tag$Key": "

Name of the object key.

", "UploadPartCopyRequest$Key": "

Object key for which the multipart upload was initiated.

", "UploadPartRequest$Key": "

Object key for which the multipart upload was initiated.

" } @@ -2858,7 +2858,7 @@ } }, "QueueConfigurationDeprecated": { - "base": "

This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

", + "base": "

This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

", "refs": { "NotificationConfigurationDeprecated$QueueConfiguration": "

This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

" } @@ -3114,7 +3114,7 @@ "base": null, "refs": { "GetObjectOutput$Restore": "

Provides information about object restoration operation and expiration time of the restored object copy.

", - "HeadObjectOutput$Restore": "

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00 GMT\"

If the object restoration is in progress, the header returns the value ongoing-request=\"true\".

For more information about archiving objects, see Transitioning Objects: General Considerations.

" + "HeadObjectOutput$Restore": "

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00 GMT\"

If the object restoration is in progress, the header returns the value ongoing-request=\"true\".

For more information about archiving objects, see Transitioning Objects: General Considerations.

" } }, "RestoreObjectOutput": { @@ -3152,7 +3152,7 @@ } }, "RoutingRule": { - "base": "

Specifies the redirect behavior and when a redirect is applied.

", + "base": "

Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the Amazon Simple Storage Service Developer Guide.

", "refs": { "RoutingRules$member": null } @@ -3212,14 +3212,14 @@ "SSECustomerKey": { "base": null, "refs": { - "CopyObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

", - "CreateMultipartUploadRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

", - "GetObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

", - "HeadObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

", - "PutObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

", + "CopyObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "CreateMultipartUploadRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "GetObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "HeadObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", + "PutObjectRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

", "SelectObjectContentRequest$SSECustomerKey": "

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

", - "UploadPartCopyRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

", - "UploadPartRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

" + "UploadPartCopyRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

", + "UploadPartRequest$SSECustomerKey": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

" } }, "SSECustomerKeyMD5": { @@ -3561,7 +3561,7 @@ } }, "TopicConfigurationDeprecated": { - "base": "

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. This data type is deprecated. Use TopicConfiguration instead.

", + "base": "

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. This data type is deprecated. Use TopicConfiguration instead.

", "refs": { "NotificationConfigurationDeprecated$TopicConfiguration": "

This data type is deprecated. 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.

" } diff --git a/models/apis/s3/2006-03-01/examples-1.json b/models/apis/s3/2006-03-01/examples-1.json index 661b5de3542..c12a1005ef4 100644 --- a/models/apis/s3/2006-03-01/examples-1.json +++ b/models/apis/s3/2006-03-01/examples-1.json @@ -292,11 +292,10 @@ { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "Key": "HappyFace.jpg" }, "output": { - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "VersionId": "null" }, "comments": { "input": { @@ -304,17 +303,18 @@ "output": { } }, - "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", - "id": "to-remove-tag-set-from-an-object-version-1483145285913", - "title": "To remove tag set from an object version" + "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", + "id": "to-remove-tag-set-from-an-object-1483145342862", + "title": "To remove tag set from an object" }, { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "HappyFace.jpg", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "output": { - "VersionId": "null" + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "comments": { "input": { @@ -322,9 +322,9 @@ "output": { } }, - "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", - "id": "to-remove-tag-set-from-an-object-1483145342862", - "title": "To remove tag set from an object" + "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", + "id": "to-remove-tag-set-from-an-object-version-1483145285913", + "title": "To remove tag set from an object version" } ], "DeleteObjects": [ @@ -989,47 +989,37 @@ "ListMultipartUploads": [ { "input": { - "Bucket": "examplebucket", - "KeyMarker": "nextkeyfrompreviousresponse", - "MaxUploads": "2", - "UploadIdMarker": "valuefrompreviousresponse" + "Bucket": "examplebucket" }, "output": { - "Bucket": "acl1", - "IsTruncated": true, - "KeyMarker": "", - "MaxUploads": "2", - "NextKeyMarker": "someobjectkey", - "NextUploadIdMarker": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", - "UploadIdMarker": "", "Uploads": [ { "Initiated": "2014-05-01T05:40:58.000Z", "Initiator": { - "DisplayName": "ownder-display-name", + "DisplayName": "display-name", "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "Key": "JavaFile", "Owner": { - "DisplayName": "mohanataws", - "ID": "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + "DisplayName": "display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "StorageClass": "STANDARD", - "UploadId": "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" + "UploadId": "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" }, { "Initiated": "2014-05-01T05:41:27.000Z", "Initiator": { - "DisplayName": "ownder-display-name", + "DisplayName": "display-name", "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "Key": "JavaFile", "Owner": { - "DisplayName": "ownder-display-name", + "DisplayName": "display-name", "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "StorageClass": "STANDARD", - "UploadId": "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" + "UploadId": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" } ] }, @@ -1039,43 +1029,53 @@ "output": { } }, - "description": "The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.", - "id": "list-next-set-of-multipart-uploads-when-previous-result-is-truncated-1482428106748", - "title": "List next set of multipart uploads when previous result is truncated" + "description": "The following example lists in-progress multipart uploads on a specific bucket.", + "id": "to-list-in-progress-multipart-uploads-on-a-bucket-1481852775260", + "title": "To list in-progress multipart uploads on a bucket" }, { "input": { - "Bucket": "examplebucket" + "Bucket": "examplebucket", + "KeyMarker": "nextkeyfrompreviousresponse", + "MaxUploads": "2", + "UploadIdMarker": "valuefrompreviousresponse" }, "output": { + "Bucket": "acl1", + "IsTruncated": true, + "KeyMarker": "", + "MaxUploads": "2", + "NextKeyMarker": "someobjectkey", + "NextUploadIdMarker": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--", + "UploadIdMarker": "", "Uploads": [ { "Initiated": "2014-05-01T05:40:58.000Z", "Initiator": { - "DisplayName": "display-name", + "DisplayName": "ownder-display-name", "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "Key": "JavaFile", "Owner": { - "DisplayName": "display-name", - "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" + "DisplayName": "mohanataws", + "ID": "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "StorageClass": "STANDARD", - "UploadId": "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" + "UploadId": "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--" }, { "Initiated": "2014-05-01T05:41:27.000Z", "Initiator": { - "DisplayName": "display-name", + "DisplayName": "ownder-display-name", "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "Key": "JavaFile", "Owner": { - "DisplayName": "display-name", + "DisplayName": "ownder-display-name", "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" }, "StorageClass": "STANDARD", - "UploadId": "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" + "UploadId": "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--" } ] }, @@ -1085,9 +1085,9 @@ "output": { } }, - "description": "The following example lists in-progress multipart uploads on a specific bucket.", - "id": "to-list-in-progress-multipart-uploads-on-a-bucket-1481852775260", - "title": "To list in-progress multipart uploads on a bucket" + "description": "The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.", + "id": "list-next-set-of-multipart-uploads-when-previous-result-is-truncated-1482428106748", + "title": "List next set of multipart uploads when previous result is truncated" } ], "ListObjectVersions": [ @@ -1570,13 +1570,14 @@ "Body": "filetoupload", "Bucket": "examplebucket", "Key": "exampleobject", - "ServerSideEncryption": "AES256", - "Tagging": "key1=value1&key2=value2" + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256", - "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" }, "comments": { "input": { @@ -1584,19 +1585,20 @@ "output": { } }, - "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", - "title": "To upload an object and specify server-side encryption and object tags" + "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", + "title": "To upload object and specify user-defined metadata" }, { "input": { + "ACL": "authenticated-read", "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "objectkey" + "Key": "exampleobject" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" }, "comments": { "input": { @@ -1604,20 +1606,19 @@ "output": { } }, - "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-create-an-object-1483147613675", - "title": "To create an object." + "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", + "title": "To upload an object and specify canned ACL." }, { "input": { - "Body": "c:\\HappyFace.jpg", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "Tagging": "key1=value1&key2=value2" + "Key": "objectkey" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" }, "comments": { "input": { @@ -1625,22 +1626,19 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", - "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", - "title": "To upload an object and specify optional tags" + "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-create-an-object-1483147613675", + "title": "To create an object." }, { "input": { "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "ServerSideEncryption": "AES256", - "StorageClass": "STANDARD_IA" + "Key": "HappyFace.jpg" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256", - "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" }, "comments": { "input": { @@ -1648,23 +1646,20 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", - "id": "to-upload-an-object-(specify-optional-headers)", - "title": "To upload an object (specify optional headers)" + "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", + "id": "to-upload-an-object-1481760101010", + "title": "To upload an object" }, { "input": { - "Body": "filetoupload", + "Body": "c:\\HappyFace.jpg", "Bucket": "examplebucket", - "Key": "exampleobject", - "Metadata": { - "metadata1": "value1", - "metadata2": "value2" - } + "Key": "HappyFace.jpg", + "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" + "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" }, "comments": { "input": { @@ -1672,20 +1667,22 @@ "output": { } }, - "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", - "title": "To upload object and specify user-defined metadata" + "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", + "title": "To upload an object and specify optional tags" }, { "input": { - "ACL": "authenticated-read", "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "exampleobject" + "Key": "exampleobject", + "ServerSideEncryption": "AES256", + "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" + "ServerSideEncryption": "AES256", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" }, "comments": { "input": { @@ -1693,19 +1690,22 @@ "output": { } }, - "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", - "title": "To upload an object and specify canned ACL." + "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", + "title": "To upload an object and specify server-side encryption and object tags" }, { "input": { "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "HappyFace.jpg", + "ServerSideEncryption": "AES256", + "StorageClass": "STANDARD_IA" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" + "ServerSideEncryption": "AES256", + "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" }, "comments": { "input": { @@ -1713,9 +1713,9 @@ "output": { } }, - "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", - "id": "to-upload-an-object-1481760101010", - "title": "To upload an object" + "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", + "id": "to-upload-an-object-(specify-optional-headers)", + "title": "To upload an object (specify optional headers)" } ], "PutObjectAcl": [ @@ -1826,14 +1826,15 @@ "input": { "Bucket": "examplebucket", "CopySource": "/bucketname/sourceobjectkey", + "CopySourceRange": "bytes=1-100000", "Key": "examplelargeobject", - "PartNumber": "1", + "PartNumber": "2", "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" }, "output": { "CopyPartResult": { - "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", - "LastModified": "2016-12-29T21:24:43.000Z" + "ETag": "\"65d16d19e65a7508a51f043180edcc36\"", + "LastModified": "2016-12-29T21:44:28.000Z" } }, "comments": { @@ -1842,23 +1843,22 @@ "output": { } }, - "description": "The following example uploads a part of a multipart upload by copying data from an existing object as data source.", - "id": "to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348", - "title": "To upload a part by copying data from an existing object as data source" + "description": "The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.", + "id": "to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594", + "title": "To upload a part by copying byte range from an existing object as data source" }, { "input": { "Bucket": "examplebucket", "CopySource": "/bucketname/sourceobjectkey", - "CopySourceRange": "bytes=1-100000", "Key": "examplelargeobject", - "PartNumber": "2", + "PartNumber": "1", "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" }, "output": { "CopyPartResult": { - "ETag": "\"65d16d19e65a7508a51f043180edcc36\"", - "LastModified": "2016-12-29T21:44:28.000Z" + "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", + "LastModified": "2016-12-29T21:24:43.000Z" } }, "comments": { @@ -1867,9 +1867,9 @@ "output": { } }, - "description": "The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.", - "id": "to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594", - "title": "To upload a part by copying byte range from an existing object as data source" + "description": "The following example uploads a part of a multipart upload by copying data from an existing object as data source.", + "id": "to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348", + "title": "To upload a part by copying data from an existing object as data source" } ] } diff --git a/models/apis/sms/2016-10-24/api-2.json b/models/apis/sms/2016-10-24/api-2.json index 4c84da37fce..e5734b746ec 100644 --- a/models/apis/sms/2016-10-24/api-2.json +++ b/models/apis/sms/2016-10-24/api-2.json @@ -97,6 +97,22 @@ {"shape":"OperationNotPermittedException"} ] }, + "DeleteAppValidationConfiguration":{ + "name":"DeleteAppValidationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppValidationConfigurationRequest"}, + "output":{"shape":"DeleteAppValidationConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ] + }, "DeleteReplicationJob":{ "name":"DeleteReplicationJob", "http":{ @@ -223,6 +239,38 @@ {"shape":"OperationNotPermittedException"} ] }, + "GetAppValidationConfiguration":{ + "name":"GetAppValidationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAppValidationConfigurationRequest"}, + "output":{"shape":"GetAppValidationConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ] + }, + "GetAppValidationOutput":{ + "name":"GetAppValidationOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAppValidationOutputRequest"}, + "output":{"shape":"GetAppValidationOutputResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ] + }, "GetConnectors":{ "name":"GetConnectors", "http":{ @@ -272,7 +320,26 @@ "input":{"shape":"GetServersRequest"}, "output":{"shape":"GetServersResponse"}, "errors":[ - {"shape":"UnauthorizedOperationException"} + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"} + ] + }, + "ImportAppCatalog":{ + "name":"ImportAppCatalog", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportAppCatalogRequest"}, + "output":{"shape":"ImportAppCatalogResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} ] }, "ImportServerCatalog":{ @@ -323,6 +390,22 @@ {"shape":"OperationNotPermittedException"} ] }, + "NotifyAppValidationOutput":{ + "name":"NotifyAppValidationOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"NotifyAppValidationOutputRequest"}, + "output":{"shape":"NotifyAppValidationOutputResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ] + }, "PutAppLaunchConfiguration":{ "name":"PutAppLaunchConfiguration", "http":{ @@ -355,6 +438,22 @@ {"shape":"OperationNotPermittedException"} ] }, + "PutAppValidationConfiguration":{ + "name":"PutAppValidationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAppValidationConfigurationRequest"}, + "output":{"shape":"PutAppValidationConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ] + }, "StartAppReplication":{ "name":"StartAppReplication", "http":{ @@ -371,6 +470,22 @@ {"shape":"OperationNotPermittedException"} ] }, + "StartOnDemandAppReplication":{ + "name":"StartOnDemandAppReplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartOnDemandAppReplicationRequest"}, + "output":{"shape":"StartOnDemandAppReplicationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ] + }, "StartOnDemandReplicationRun":{ "name":"StartOnDemandReplicationRun", "http":{ @@ -384,7 +499,8 @@ {"shape":"MissingRequiredParameterException"}, {"shape":"UnauthorizedOperationException"}, {"shape":"OperationNotPermittedException"}, - {"shape":"ReplicationRunLimitExceededException"} + {"shape":"ReplicationRunLimitExceededException"}, + {"shape":"DryRunOperationException"} ] }, "StopAppReplication":{ @@ -459,10 +575,21 @@ "AmiId":{"type":"string"}, "AppDescription":{"type":"string"}, "AppId":{"type":"string"}, + "AppIdWithValidation":{ + "type":"string", + "pattern":"^app-[0-9a-f]{17}$" + }, "AppIds":{ "type":"list", "member":{"shape":"AppId"} }, + "AppLaunchConfigurationStatus":{ + "type":"string", + "enum":[ + "NOT_CONFIGURED", + "CONFIGURED" + ] + }, "AppLaunchStatus":{ "type":"string", "enum":[ @@ -474,6 +601,7 @@ "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", + "PARTIALLY_LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", @@ -484,6 +612,13 @@ }, "AppLaunchStatusMessage":{"type":"string"}, "AppName":{"type":"string"}, + "AppReplicationConfigurationStatus":{ + "type":"string", + "enum":[ + "NOT_CONFIGURED", + "CONFIGURED" + ] + }, "AppReplicationStatus":{ "type":"string", "enum":[ @@ -495,6 +630,7 @@ "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", + "PARTIALLY_REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", @@ -521,13 +657,16 @@ "type":"structure", "members":{ "appId":{"shape":"AppId"}, + "importedAppId":{"shape":"ImportedAppId"}, "name":{"shape":"AppName"}, "description":{"shape":"AppDescription"}, "status":{"shape":"AppStatus"}, "statusMessage":{"shape":"AppStatusMessage"}, + "replicationConfigurationStatus":{"shape":"AppReplicationConfigurationStatus"}, "replicationStatus":{"shape":"AppReplicationStatus"}, "replicationStatusMessage":{"shape":"AppReplicationStatusMessage"}, "latestReplicationTime":{"shape":"Timestamp"}, + "launchConfigurationStatus":{"shape":"AppLaunchConfigurationStatus"}, "launchStatus":{"shape":"AppLaunchStatus"}, "launchStatusMessage":{"shape":"AppLaunchStatusMessage"}, "launchDetails":{"shape":"LaunchDetails"}, @@ -538,13 +677,42 @@ "totalServers":{"shape":"TotalServers"} } }, + "AppValidationConfiguration":{ + "type":"structure", + "members":{ + "validationId":{"shape":"ValidationId"}, + "name":{"shape":"NonEmptyStringWithMaxLen255"}, + "appValidationStrategy":{"shape":"AppValidationStrategy"}, + "ssmValidationParameters":{"shape":"SSMValidationParameters"} + } + }, + "AppValidationConfigurations":{ + "type":"list", + "member":{"shape":"AppValidationConfiguration"} + }, + "AppValidationOutput":{ + "type":"structure", + "members":{ + "ssmOutput":{"shape":"SSMOutput"} + } + }, + "AppValidationStrategy":{ + "type":"string", + "enum":["SSM"] + }, "Apps":{ "type":"list", "member":{"shape":"AppSummary"} }, "AssociatePublicIpAddress":{"type":"boolean"}, + "AutoLaunch":{"type":"boolean"}, "BucketName":{"type":"string"}, "ClientToken":{"type":"string"}, + "Command":{ + "type":"string", + "max":64000, + "min":1 + }, "Connector":{ "type":"structure", "members":{ @@ -566,7 +734,8 @@ "VSPHERE", "SCVMM", "HYPERV-MANAGER", - "SNAPSHOT_BATCHING" + "SNAPSHOT_BATCHING", + "SMS_OPTIMIZED" ] }, "ConnectorCapabilityList":{ @@ -665,6 +834,18 @@ "members":{ } }, + "DeleteAppValidationConfigurationRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{"shape":"AppIdWithValidation"} + } + }, + "DeleteAppValidationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteReplicationJobRequest":{ "type":"structure", "required":["replicationJobId"], @@ -700,9 +881,21 @@ "members":{ } }, + "DryRunOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, "EC2KeyName":{"type":"string"}, "Encrypted":{"type":"boolean"}, "ErrorMessage":{"type":"string"}, + "ExecutionTimeoutSeconds":{ + "type":"integer", + "max":28800, + "min":60 + }, "ForceStopAppReplication":{"type":"boolean"}, "ForceTerminateApp":{"type":"boolean"}, "Frequency":{"type":"integer"}, @@ -743,6 +936,7 @@ "members":{ "appId":{"shape":"AppId"}, "roleName":{"shape":"RoleName"}, + "autoLaunch":{"shape":"AutoLaunch"}, "serverGroupLaunchConfigurations":{"shape":"ServerGroupLaunchConfigurations"} } }, @@ -772,6 +966,33 @@ "tags":{"shape":"Tags"} } }, + "GetAppValidationConfigurationRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{"shape":"AppIdWithValidation"} + } + }, + "GetAppValidationConfigurationResponse":{ + "type":"structure", + "members":{ + "appValidationConfigurations":{"shape":"AppValidationConfigurations"}, + "serverGroupValidationConfigurations":{"shape":"ServerGroupValidationConfigurations"} + } + }, + "GetAppValidationOutputRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{"shape":"AppIdWithValidation"} + } + }, + "GetAppValidationOutputResponse":{ + "type":"structure", + "members":{ + "validationOutputList":{"shape":"ValidationOutputList"} + } + }, "GetConnectorsRequest":{ "type":"structure", "members":{ @@ -835,6 +1056,17 @@ "nextToken":{"shape":"NextToken"} } }, + "ImportAppCatalogRequest":{ + "type":"structure", + "members":{ + "roleName":{"shape":"RoleName"} + } + }, + "ImportAppCatalogResponse":{ + "type":"structure", + "members":{ + } + }, "ImportServerCatalogRequest":{ "type":"structure", "members":{ @@ -845,6 +1077,11 @@ "members":{ } }, + "ImportedAppId":{"type":"string"}, + "InstanceId":{ + "type":"string", + "pattern":"(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" + }, "InstanceType":{"type":"string"}, "InternalError":{ "type":"structure", @@ -862,7 +1099,6 @@ "exception":true }, "IpAddress":{"type":"string"}, - "KeyName":{"type":"string"}, "KmsKeyId":{"type":"string"}, "LaunchAppRequest":{ "type":"structure", @@ -924,6 +1160,33 @@ }, "exception":true }, + "NonEmptyStringWithMaxLen255":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[\\S]+$" + }, + "NotificationContext":{ + "type":"structure", + "members":{ + "validationId":{"shape":"ValidationId"}, + "status":{"shape":"ValidationStatus"}, + "statusMessage":{"shape":"ValidationStatusMessage"} + } + }, + "NotifyAppValidationOutputRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{"shape":"AppIdWithValidation"}, + "notificationContext":{"shape":"NotificationContext"} + } + }, + "NotifyAppValidationOutputResponse":{ + "type":"structure", + "members":{ + } + }, "NumberOfRecentAmisToKeep":{"type":"integer"}, "OperationNotPermittedException":{ "type":"structure", @@ -944,6 +1207,7 @@ "members":{ "appId":{"shape":"AppId"}, "roleName":{"shape":"RoleName"}, + "autoLaunch":{"shape":"AutoLaunch"}, "serverGroupLaunchConfigurations":{"shape":"ServerGroupLaunchConfigurations"} } }, @@ -964,6 +1228,20 @@ "members":{ } }, + "PutAppValidationConfigurationRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{"shape":"AppIdWithValidation"}, + "appValidationConfigurations":{"shape":"AppValidationConfigurations"}, + "serverGroupValidationConfigurations":{"shape":"ServerGroupValidationConfigurations"} + } + }, + "PutAppValidationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, "ReplicationJob":{ "type":"structure", "members":{ @@ -1080,13 +1358,46 @@ }, "RoleName":{"type":"string"}, "RunOnce":{"type":"boolean"}, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3 + }, + "S3KeyName":{ + "type":"string", + "max":1024 + }, "S3Location":{ "type":"structure", "members":{ - "bucket":{"shape":"BucketName"}, - "key":{"shape":"KeyName"} + "bucket":{"shape":"S3BucketName"}, + "key":{"shape":"S3KeyName"} } }, + "SSMOutput":{ + "type":"structure", + "members":{ + "s3Location":{"shape":"S3Location"} + } + }, + "SSMValidationParameters":{ + "type":"structure", + "members":{ + "source":{"shape":"Source"}, + "instanceId":{"shape":"InstanceId"}, + "scriptType":{"shape":"ScriptType"}, + "command":{"shape":"Command"}, + "executionTimeoutSeconds":{"shape":"ExecutionTimeoutSeconds"}, + "outputS3BucketName":{"shape":"BucketName"} + } + }, + "ScriptType":{ + "type":"string", + "enum":[ + "SHELL_SCRIPT", + "POWERSHELL_SCRIPT" + ] + }, "SecurityGroup":{"type":"string"}, "Server":{ "type":"structure", @@ -1148,6 +1459,17 @@ "type":"list", "member":{"shape":"ServerGroupReplicationConfiguration"} }, + "ServerGroupValidationConfiguration":{ + "type":"structure", + "members":{ + "serverGroupId":{"shape":"ServerGroupId"}, + "serverValidationConfigurations":{"shape":"ServerValidationConfigurations"} + } + }, + "ServerGroupValidationConfigurations":{ + "type":"list", + "member":{"shape":"ServerGroupValidationConfiguration"} + }, "ServerGroups":{ "type":"list", "member":{"shape":"ServerGroup"} @@ -1164,7 +1486,10 @@ "ec2KeyName":{"shape":"EC2KeyName"}, "userData":{"shape":"UserData"}, "instanceType":{"shape":"InstanceType"}, - "associatePublicIpAddress":{"shape":"AssociatePublicIpAddress"} + "associatePublicIpAddress":{"shape":"AssociatePublicIpAddress"}, + "iamInstanceProfileName":{"shape":"RoleName"}, + "configureScript":{"shape":"S3Location"}, + "configureScriptType":{"shape":"ScriptType"} } }, "ServerLaunchConfigurations":{ @@ -1202,6 +1527,36 @@ "type":"string", "enum":["VIRTUAL_MACHINE"] }, + "ServerValidationConfiguration":{ + "type":"structure", + "members":{ + "server":{"shape":"Server"}, + "validationId":{"shape":"ValidationId"}, + "name":{"shape":"NonEmptyStringWithMaxLen255"}, + "serverValidationStrategy":{"shape":"ServerValidationStrategy"}, + "userDataValidationParameters":{"shape":"UserDataValidationParameters"} + } + }, + "ServerValidationConfigurations":{ + "type":"list", + "member":{"shape":"ServerValidationConfiguration"} + }, + "ServerValidationOutput":{ + "type":"structure", + "members":{ + "server":{"shape":"Server"} + } + }, + "ServerValidationStrategy":{ + "type":"string", + "enum":["USERDATA"] + }, + "Source":{ + "type":"structure", + "members":{ + "s3Location":{"shape":"S3Location"} + } + }, "StackId":{"type":"string"}, "StackName":{"type":"string"}, "StartAppReplicationRequest":{ @@ -1215,6 +1570,19 @@ "members":{ } }, + "StartOnDemandAppReplicationRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{"shape":"AppId"}, + "description":{"shape":"Description"} + } + }, + "StartOnDemandAppReplicationResponse":{ + "type":"structure", + "members":{ + } + }, "StartOnDemandReplicationRunRequest":{ "type":"structure", "required":["replicationJobId"], @@ -1327,7 +1695,48 @@ "s3Location":{"shape":"S3Location"} } }, + "UserDataValidationParameters":{ + "type":"structure", + "members":{ + "source":{"shape":"Source"}, + "scriptType":{"shape":"ScriptType"} + } + }, "VPC":{"type":"string"}, + "ValidationId":{ + "type":"string", + "pattern":"^val-[0-9a-f]{17}$" + }, + "ValidationOutput":{ + "type":"structure", + "members":{ + "validationId":{"shape":"ValidationId"}, + "name":{"shape":"NonEmptyStringWithMaxLen255"}, + "status":{"shape":"ValidationStatus"}, + "statusMessage":{"shape":"ValidationStatusMessage"}, + "latestValidationTime":{"shape":"Timestamp"}, + "appValidationOutput":{"shape":"AppValidationOutput"}, + "serverValidationOutput":{"shape":"ServerValidationOutput"} + } + }, + "ValidationOutputList":{ + "type":"list", + "member":{"shape":"ValidationOutput"} + }, + "ValidationStatus":{ + "type":"string", + "enum":[ + "READY_FOR_VALIDATION", + "PENDING", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "ValidationStatusMessage":{ + "type":"string", + "max":2500 + }, "VmId":{"type":"string"}, "VmManagerId":{"type":"string"}, "VmManagerName":{"type":"string"}, diff --git a/models/apis/sms/2016-10-24/docs-2.json b/models/apis/sms/2016-10-24/docs-2.json index 8dc3e8b503a..7996bb83f79 100644 --- a/models/apis/sms/2016-10-24/docs-2.json +++ b/models/apis/sms/2016-10-24/docs-2.json @@ -1,34 +1,41 @@ { "version": "2.0", - "service": "AAWS Sever Migration Service

This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

To learn more about the Server Migration Service, see the following resources:

", + "service": "AWS Server Migration Service

AWS Server Migration Service (AWS SMS) makes it easier and faster for you to migrate your on-premises workloads to AWS. To learn more about AWS SMS, see the following resources:

", "operations": { "CreateApp": "

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

", "CreateReplicationJob": "

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

", - "DeleteApp": "

Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

", - "DeleteAppLaunchConfiguration": "

Deletes existing launch configuration for an application.

", - "DeleteAppReplicationConfiguration": "

Deletes existing replication configuration for an application.

", + "DeleteApp": "

Deletes the specified application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

", + "DeleteAppLaunchConfiguration": "

Deletes the launch configuration for the specified application.

", + "DeleteAppReplicationConfiguration": "

Deletes the replication configuration for the specified application.

", + "DeleteAppValidationConfiguration": "

Deletes the validation configuration for the specified application.

", "DeleteReplicationJob": "

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.

", "DeleteServerCatalog": "

Deletes all servers from your server catalog.

", "DisassociateConnector": "

Disassociates the specified connector from AWS SMS.

After you disassociate a connector, it is no longer available to support replication jobs.

", "GenerateChangeSet": "

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

", - "GenerateTemplate": "

Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

", - "GetApp": "

Retrieve information about an application.

", - "GetAppLaunchConfiguration": "

Retrieves the application launch configuration associated with an application.

", - "GetAppReplicationConfiguration": "

Retrieves an application replication configuration associatd with an application.

", + "GenerateTemplate": "

Generates an AWS CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

", + "GetApp": "

Retrieve information about the specified application.

", + "GetAppLaunchConfiguration": "

Retrieves the application launch configuration associated with the specified application.

", + "GetAppReplicationConfiguration": "

Retrieves the application replication configuration associated with the specified application.

", + "GetAppValidationConfiguration": "

Retrieves information about a configuration for validating an application.

", + "GetAppValidationOutput": "

Retrieves output from validating an application.

", "GetConnectors": "

Describes the connectors registered with the AWS SMS.

", "GetReplicationJobs": "

Describes the specified replication job or all of your replication jobs.

", "GetReplicationRuns": "

Describes the replication runs for the specified replication job.

", "GetServers": "

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

", - "ImportServerCatalog": "

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import.

This call returns immediately, but might take additional time to retrieve all the servers.

", - "LaunchApp": "

Launches an application stack.

", - "ListApps": "

Returns a list of summaries for all applications.

", - "PutAppLaunchConfiguration": "

Creates a launch configuration for an application.

", - "PutAppReplicationConfiguration": "

Creates or updates a replication configuration for an application.

", - "StartAppReplication": "

Starts replicating an application.

", - "StartOnDemandReplicationRun": "

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs you can request in a 24-hour period.

", - "StopAppReplication": "

Stops replicating an application.

", - "TerminateApp": "

Terminates the stack for an application.

", - "UpdateApp": "

Updates an application.

", + "ImportAppCatalog": "

Allows application import from AWS Migration Hub.

", + "ImportServerCatalog": "

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

This call returns immediately, but might take additional time to retrieve all the servers.

", + "LaunchApp": "

Launches the specified application as a stack in AWS CloudFormation.

", + "ListApps": "

Retrieves summaries for all applications.

", + "NotifyAppValidationOutput": "

Provides information to AWS SMS about whether application validation is successful.

", + "PutAppLaunchConfiguration": "

Creates or updates the launch configuration for the specified application.

", + "PutAppReplicationConfiguration": "

Creates or updates the replication configuration for the specified application.

", + "PutAppValidationConfiguration": "

Creates or updates a validation configuration for the specified application.

", + "StartAppReplication": "

Starts replicating the specified application by creating replication jobs for each server in the application.

", + "StartOnDemandAppReplication": "

Starts an on-demand replication run for the specified application.

", + "StartOnDemandReplicationRun": "

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

", + "StopAppReplication": "

Stops replicating the specified application by deleting the replication job for each server in the application.

", + "TerminateApp": "

Terminates the stack for the specified application.

", + "UpdateApp": "

Updates the specified application.

", "UpdateReplicationJob": "

Updates the specified settings for the specified replication job.

" }, "shapes": { @@ -36,50 +43,67 @@ "base": null, "refs": { "ReplicationJob$latestAmiId": "

The ID of the latest Amazon Machine Image (AMI).

", - "ReplicationRun$amiId": "

The identifier of the Amazon Machine Image (AMI) from the replication run.

" + "ReplicationRun$amiId": "

The ID of the Amazon Machine Image (AMI) from the replication run.

" } }, "AppDescription": { "base": null, "refs": { - "AppSummary$description": "

Description of the application.

", - "CreateAppRequest$description": "

Description of the new application

", - "UpdateAppRequest$description": "

New description of the application.

" + "AppSummary$description": "

The description of the application.

", + "CreateAppRequest$description": "

The description of the new application

", + "UpdateAppRequest$description": "

The new description of the application.

" } }, "AppId": { "base": null, "refs": { "AppIds$member": null, - "AppSummary$appId": "

Unique ID of the application.

", - "DeleteAppLaunchConfigurationRequest$appId": "

ID of the application associated with the launch configuration.

", - "DeleteAppReplicationConfigurationRequest$appId": "

ID of the application associated with the replication configuration.

", - "DeleteAppRequest$appId": "

ID of the application to delete.

", - "GenerateChangeSetRequest$appId": "

ID of the application associated with the change set.

", - "GenerateTemplateRequest$appId": "

ID of the application associated with the Amazon CloudFormation template.

", - "GetAppLaunchConfigurationRequest$appId": "

ID of the application launch configuration.

", - "GetAppLaunchConfigurationResponse$appId": "

ID of the application associated with the launch configuration.

", - "GetAppReplicationConfigurationRequest$appId": "

ID of the application associated with the replication configuration.

", - "GetAppRequest$appId": "

ID of the application whose information is being retrieved.

", - "LaunchAppRequest$appId": "

ID of the application to launch.

", - "PutAppLaunchConfigurationRequest$appId": "

ID of the application associated with the launch configuration.

", - "PutAppReplicationConfigurationRequest$appId": "

ID of the application tassociated with the replication configuration.

", - "StartAppReplicationRequest$appId": "

ID of the application to replicate.

", - "StopAppReplicationRequest$appId": "

ID of the application to stop replicating.

", - "TerminateAppRequest$appId": "

ID of the application to terminate.

", - "UpdateAppRequest$appId": "

ID of the application to update.

" + "AppSummary$appId": "

The unique ID of the application.

", + "DeleteAppLaunchConfigurationRequest$appId": "

The ID of the application.

", + "DeleteAppReplicationConfigurationRequest$appId": "

The ID of the application.

", + "DeleteAppRequest$appId": "

The ID of the application.

", + "GenerateChangeSetRequest$appId": "

The ID of the application associated with the change set.

", + "GenerateTemplateRequest$appId": "

The ID of the application associated with the AWS CloudFormation template.

", + "GetAppLaunchConfigurationRequest$appId": "

The ID of the application.

", + "GetAppLaunchConfigurationResponse$appId": "

The ID of the application.

", + "GetAppReplicationConfigurationRequest$appId": "

The ID of the application.

", + "GetAppRequest$appId": "

The ID of the application.

", + "LaunchAppRequest$appId": "

The ID of the application.

", + "PutAppLaunchConfigurationRequest$appId": "

The ID of the application.

", + "PutAppReplicationConfigurationRequest$appId": "

The ID of the application.

", + "StartAppReplicationRequest$appId": "

The ID of the application.

", + "StartOnDemandAppReplicationRequest$appId": "

The ID of the application.

", + "StopAppReplicationRequest$appId": "

The ID of the application.

", + "TerminateAppRequest$appId": "

The ID of the application.

", + "UpdateAppRequest$appId": "

The ID of the application.

" + } + }, + "AppIdWithValidation": { + "base": null, + "refs": { + "DeleteAppValidationConfigurationRequest$appId": "

The ID of the application.

", + "GetAppValidationConfigurationRequest$appId": "

The ID of the application.

", + "GetAppValidationOutputRequest$appId": "

The ID of the application.

", + "NotifyAppValidationOutputRequest$appId": "

The ID of the application.

", + "PutAppValidationConfigurationRequest$appId": "

The ID of the application.

" } }, "AppIds": { "base": null, "refs": { - "ListAppsRequest$appIds": "

" + "ListAppsRequest$appIds": "

The unique application IDs.

" + } + }, + "AppLaunchConfigurationStatus": { + "base": null, + "refs": { + "AppSummary$launchConfigurationStatus": "

Status of the launch configuration.

" } }, "AppLaunchStatus": { "base": null, "refs": { - "AppSummary$launchStatus": "

Launch status of the application.

" + "AppSummary$launchStatus": "

The launch status of the application.

" } }, "AppLaunchStatusMessage": { @@ -91,15 +115,21 @@ "AppName": { "base": null, "refs": { - "AppSummary$name": "

Name of the application.

", - "CreateAppRequest$name": "

Name of the new application.

", - "UpdateAppRequest$name": "

New name of the application.

" + "AppSummary$name": "

The name of the application.

", + "CreateAppRequest$name": "

The name of the new application.

", + "UpdateAppRequest$name": "

The new name of the application.

" + } + }, + "AppReplicationConfigurationStatus": { + "base": null, + "refs": { + "AppSummary$replicationConfigurationStatus": "

Status of the replication configuration.

" } }, "AppReplicationStatus": { "base": null, "refs": { - "AppSummary$replicationStatus": "

Replication status of the application.

" + "AppSummary$replicationStatus": "

The replication status of the application.

" } }, "AppReplicationStatusMessage": { @@ -124,33 +154,71 @@ "base": "

Information about the application.

", "refs": { "Apps$member": null, - "CreateAppResponse$appSummary": "

Summary description of the application.

", + "CreateAppResponse$appSummary": "

A summary description of the application.

", "GetAppResponse$appSummary": "

Information about the application.

", - "UpdateAppResponse$appSummary": "

Summary description of the application.

" + "UpdateAppResponse$appSummary": "

A summary description of the application.

" + } + }, + "AppValidationConfiguration": { + "base": "

Configuration for validating an application.

", + "refs": { + "AppValidationConfigurations$member": null + } + }, + "AppValidationConfigurations": { + "base": null, + "refs": { + "GetAppValidationConfigurationResponse$appValidationConfigurations": "

The configuration for application validation.

", + "PutAppValidationConfigurationRequest$appValidationConfigurations": "

The configuration for application validation.

" + } + }, + "AppValidationOutput": { + "base": "

Output from validating an application.

", + "refs": { + "ValidationOutput$appValidationOutput": "

The output from validating an application.

" + } + }, + "AppValidationStrategy": { + "base": null, + "refs": { + "AppValidationConfiguration$appValidationStrategy": "

The validation strategy.

" } }, "Apps": { "base": null, "refs": { - "ListAppsResponse$apps": "

A list of application summaries.

" + "ListAppsResponse$apps": "

The application summaries.

" } }, "AssociatePublicIpAddress": { "base": null, "refs": { - "ServerLaunchConfiguration$associatePublicIpAddress": "

If true, a publicly accessible IP address is created when launching the server.

" + "ServerLaunchConfiguration$associatePublicIpAddress": "

Indicates whether a publicly accessible IP address is created when launching the server.

" + } + }, + "AutoLaunch": { + "base": null, + "refs": { + "GetAppLaunchConfigurationResponse$autoLaunch": "

Indicates whether the application is configured to launch automatically after replication is complete.

", + "PutAppLaunchConfigurationRequest$autoLaunch": "

Indicates whether the application is configured to launch automatically after replication is complete.

" } }, "BucketName": { "base": null, "refs": { - "S3Location$bucket": "

Amazon S3 bucket name.

" + "SSMValidationParameters$outputS3BucketName": "

The name of the S3 bucket for output.

" } }, "ClientToken": { "base": null, "refs": { - "CreateAppRequest$clientToken": "

A unique, case-sensitive identifier you provide to ensure idempotency of application creation.

" + "CreateAppRequest$clientToken": "

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

" + } + }, + "Command": { + "base": null, + "refs": { + "SSMValidationParameters$command": "

The command to run the validation script

" } }, "Connector": { @@ -174,8 +242,8 @@ "ConnectorId": { "base": null, "refs": { - "Connector$connectorId": "

The identifier of the connector.

", - "DisassociateConnectorRequest$connectorId": "

The identifier of the connector.

" + "Connector$connectorId": "

The ID of the connector.

", + "DisassociateConnectorRequest$connectorId": "

The ID of the connector.

" } }, "ConnectorList": { @@ -246,6 +314,16 @@ "refs": { } }, + "DeleteAppValidationConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DeleteAppValidationConfigurationResponse": { + "base": null, + "refs": { + } + }, "DeleteReplicationJobRequest": { "base": null, "refs": { @@ -272,6 +350,7 @@ "CreateReplicationJobRequest$description": "

The description of the replication job.

", "ReplicationJob$description": "

The description of the replication job.

", "ReplicationRun$description": "

The description of the replication run.

", + "StartOnDemandAppReplicationRequest$description": "

The description of the replication run.

", "StartOnDemandReplicationRunRequest$description": "

The description of the replication run.

", "UpdateReplicationJobRequest$description": "

The description of the replication job.

" } @@ -286,25 +365,31 @@ "refs": { } }, + "DryRunOperationException": { + "base": "

The user has the required permissions, so the request would have succeeded, but a dry run was performed.

", + "refs": { + } + }, "EC2KeyName": { "base": null, "refs": { - "ServerLaunchConfiguration$ec2KeyName": "

Name of the EC2 SSH Key to be used for connecting to the launched server.

" + "ServerLaunchConfiguration$ec2KeyName": "

The name of the Amazon EC2 SSH key to be used for connecting to the launched server.

" } }, "Encrypted": { "base": null, "refs": { - "CreateReplicationJobRequest$encrypted": "

When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

", - "ReplicationJob$encrypted": "

Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below.

", - "ReplicationRun$encrypted": "

Whether the replication run should produce encrypted AMI or not. See also KmsKeyId below.

", - "ServerReplicationParameters$encrypted": "

When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

", - "UpdateReplicationJobRequest$encrypted": "

When true, the replication job produces encrypted AMIs . See also KmsKeyId below.

" + "CreateReplicationJobRequest$encrypted": "

Indicates whether the replication job produces encrypted AMIs.

", + "ReplicationJob$encrypted": "

Indicates whether the replication job should produce encrypted AMIs.

", + "ReplicationRun$encrypted": "

Indicates whether the replication run should produce an encrypted AMI.

", + "ServerReplicationParameters$encrypted": "

Indicates whether the replication job produces encrypted AMIs.

", + "UpdateReplicationJobRequest$encrypted": "

When true, the replication job produces encrypted AMIs. For more information, KmsKeyId.

" } }, "ErrorMessage": { "base": null, "refs": { + "DryRunOperationException$message": null, "InternalError$message": null, "InvalidParameterException$message": null, "MissingRequiredParameterException$message": null, @@ -317,16 +402,22 @@ "UnauthorizedOperationException$message": null } }, + "ExecutionTimeoutSeconds": { + "base": null, + "refs": { + "SSMValidationParameters$executionTimeoutSeconds": "

The timeout interval, in seconds.

" + } + }, "ForceStopAppReplication": { "base": null, "refs": { - "DeleteAppRequest$forceStopAppReplication": "

While deleting the application, stop all replication jobs corresponding to the servers in the application.

" + "DeleteAppRequest$forceStopAppReplication": "

Indicates whether to stop all replication jobs corresponding to the servers in the application while deleting the application.

" } }, "ForceTerminateApp": { "base": null, "refs": { - "DeleteAppRequest$forceTerminateApp": "

While deleting the application, terminate the stack corresponding to the application.

" + "DeleteAppRequest$forceTerminateApp": "

Indicates whether to terminate the stack corresponding to the application while deleting the application.

" } }, "Frequency": { @@ -334,7 +425,7 @@ "refs": { "CreateReplicationJobRequest$frequency": "

The time between consecutive replication runs, in hours.

", "ReplicationJob$frequency": "

The time between consecutive replication runs, in hours.

", - "ServerReplicationParameters$frequency": "

Frequency of creating replication jobs for the server.

", + "ServerReplicationParameters$frequency": "

The frequency of creating replication jobs for the server.

", "UpdateReplicationJobRequest$frequency": "

The time between consecutive replication runs, in hours.

" } }, @@ -388,6 +479,26 @@ "refs": { } }, + "GetAppValidationConfigurationRequest": { + "base": null, + "refs": { + } + }, + "GetAppValidationConfigurationResponse": { + "base": null, + "refs": { + } + }, + "GetAppValidationOutputRequest": { + "base": null, + "refs": { + } + }, + "GetAppValidationOutputResponse": { + "base": null, + "refs": { + } + }, "GetConnectorsRequest": { "base": null, "refs": { @@ -428,6 +539,16 @@ "refs": { } }, + "ImportAppCatalogRequest": { + "base": null, + "refs": { + } + }, + "ImportAppCatalogResponse": { + "base": null, + "refs": { + } + }, "ImportServerCatalogRequest": { "base": null, "refs": { @@ -438,10 +559,22 @@ "refs": { } }, + "ImportedAppId": { + "base": null, + "refs": { + "AppSummary$importedAppId": "

The ID of the application.

" + } + }, + "InstanceId": { + "base": null, + "refs": { + "SSMValidationParameters$instanceId": "

The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

" + } + }, "InstanceType": { "base": null, "refs": { - "ServerLaunchConfiguration$instanceType": "

Instance type to be used for launching the server.

" + "ServerLaunchConfiguration$instanceType": "

The instance type to use when launching the server.

" } }, "InternalError": { @@ -460,20 +593,14 @@ "Connector$ipAddress": "

The IP address of the connector.

" } }, - "KeyName": { - "base": null, - "refs": { - "S3Location$key": "

Amazon S3 bucket key.

" - } - }, "KmsKeyId": { "base": null, "refs": { - "CreateReplicationJobRequest$kmsKeyId": "

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to KMS key ID

  • ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

", - "ReplicationJob$kmsKeyId": "

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to KMS key ID

  • ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

", - "ReplicationRun$kmsKeyId": "

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to KMS key ID

  • ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

", - "ServerReplicationParameters$kmsKeyId": "

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to KMS key ID

  • ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

", - "UpdateReplicationJobRequest$kmsKeyId": "

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to KMS key ID

  • ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

" + "CreateReplicationJobRequest$kmsKeyId": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

", + "ReplicationJob$kmsKeyId": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

", + "ReplicationRun$kmsKeyId": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

", + "ServerReplicationParameters$kmsKeyId": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

", + "UpdateReplicationJobRequest$kmsKeyId": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

" } }, "LaunchAppRequest": { @@ -495,7 +622,7 @@ "LaunchOrder": { "base": null, "refs": { - "ServerGroupLaunchConfiguration$launchOrder": "

Launch order of servers in the server group.

" + "ServerGroupLaunchConfiguration$launchOrder": "

The launch order of servers in the server group.

" } }, "LicenseType": { @@ -503,7 +630,7 @@ "refs": { "CreateReplicationJobRequest$licenseType": "

The license type to be used for the AMI created by a successful replication run.

", "ReplicationJob$licenseType": "

The license type to be used for the AMI created by a successful replication run.

", - "ServerReplicationParameters$licenseType": "

License type for creating a replication job for the server.

", + "ServerReplicationParameters$licenseType": "

The license type for creating a replication job for the server.

", "UpdateReplicationJobRequest$licenseType": "

The license type to be used for the AMI created by a successful replication run.

" } }, @@ -520,7 +647,7 @@ "LogicalId": { "base": null, "refs": { - "ServerLaunchConfiguration$logicalId": "

Logical ID of the server in the Amazon CloudFormation template.

" + "ServerLaunchConfiguration$logicalId": "

The logical ID of the server in the AWS CloudFormation template.

" } }, "MacAddress": { @@ -536,7 +663,7 @@ "GetReplicationJobsRequest$maxResults": "

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

", "GetReplicationRunsRequest$maxResults": "

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

", "GetServersRequest$maxResults": "

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

", - "ListAppsRequest$maxResults": "

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

" + "ListAppsRequest$maxResults": "

The maximum number of results to return in a single call. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" } }, "MissingRequiredParameterException": { @@ -564,13 +691,37 @@ "refs": { } }, + "NonEmptyStringWithMaxLen255": { + "base": null, + "refs": { + "AppValidationConfiguration$name": "

The name of the configuration.

", + "ServerValidationConfiguration$name": "

The name of the configuration.

", + "ValidationOutput$name": "

The name of the validation.

" + } + }, + "NotificationContext": { + "base": "

Contains the status of validating an application.

", + "refs": { + "NotifyAppValidationOutputRequest$notificationContext": "

The notification information.

" + } + }, + "NotifyAppValidationOutputRequest": { + "base": null, + "refs": { + } + }, + "NotifyAppValidationOutputResponse": { + "base": null, + "refs": { + } + }, "NumberOfRecentAmisToKeep": { "base": null, "refs": { - "CreateReplicationJobRequest$numberOfRecentAmisToKeep": "

The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.

", - "ReplicationJob$numberOfRecentAmisToKeep": "

Number of recent AMIs to keep in the customer's account for a replication job. By default the value is set to zero, meaning that all AMIs are kept.

", - "ServerReplicationParameters$numberOfRecentAmisToKeep": "

Number of recent AMIs to keep when creating a replication job for this server.

", - "UpdateReplicationJobRequest$numberOfRecentAmisToKeep": "

The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.

" + "CreateReplicationJobRequest$numberOfRecentAmisToKeep": "

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

", + "ReplicationJob$numberOfRecentAmisToKeep": "

The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

", + "ServerReplicationParameters$numberOfRecentAmisToKeep": "

The number of recent AMIs to keep when creating a replication job for this server.

", + "UpdateReplicationJobRequest$numberOfRecentAmisToKeep": "

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

" } }, "OperationNotPermittedException": { @@ -581,8 +732,8 @@ "OutputFormat": { "base": null, "refs": { - "GenerateChangeSetRequest$changesetFormat": "

Format for the change set.

", - "GenerateTemplateRequest$templateFormat": "

Format for generating the Amazon CloudFormation template.

" + "GenerateChangeSetRequest$changesetFormat": "

The format for the change set.

", + "GenerateTemplateRequest$templateFormat": "

The format for generating the AWS CloudFormation template.

" } }, "PutAppLaunchConfigurationRequest": { @@ -605,6 +756,16 @@ "refs": { } }, + "PutAppValidationConfigurationRequest": { + "base": null, + "refs": { + } + }, + "PutAppValidationConfigurationResponse": { + "base": null, + "refs": { + } + }, "ReplicationJob": { "base": "

Represents a replication job.

", "refs": { @@ -621,13 +782,13 @@ "base": null, "refs": { "CreateReplicationJobResponse$replicationJobId": "

The unique identifier of the replication job.

", - "DeleteReplicationJobRequest$replicationJobId": "

The identifier of the replication job.

", - "GetReplicationJobsRequest$replicationJobId": "

The identifier of the replication job.

", - "GetReplicationRunsRequest$replicationJobId": "

The identifier of the replication job.

", - "ReplicationJob$replicationJobId": "

The identifier of the replication job.

", - "Server$replicationJobId": "

The identifier of the replication job.

", - "StartOnDemandReplicationRunRequest$replicationJobId": "

The identifier of the replication job.

", - "UpdateReplicationJobRequest$replicationJobId": "

The identifier of the replication job.

" + "DeleteReplicationJobRequest$replicationJobId": "

The ID of the replication job.

", + "GetReplicationJobsRequest$replicationJobId": "

The ID of the replication job.

", + "GetReplicationRunsRequest$replicationJobId": "

The ID of the replication job.

", + "ReplicationJob$replicationJobId": "

The ID of the replication job.

", + "Server$replicationJobId": "

The ID of the replication job.

", + "StartOnDemandReplicationRunRequest$replicationJobId": "

The ID of the replication job.

", + "UpdateReplicationJobRequest$replicationJobId": "

The ID of the replication job.

" } }, "ReplicationJobList": { @@ -668,8 +829,8 @@ "ReplicationRunId": { "base": null, "refs": { - "ReplicationRun$replicationRunId": "

The identifier of the replication run.

", - "StartOnDemandReplicationRunResponse$replicationRunId": "

The identifier of the replication run.

" + "ReplicationRun$replicationRunId": "

The ID of the replication run.

", + "StartOnDemandReplicationRunResponse$replicationRunId": "

The ID of the replication run.

" } }, "ReplicationRunLimitExceededException": { @@ -687,19 +848,19 @@ "ReplicationRunStage": { "base": null, "refs": { - "ReplicationRunStageDetails$stage": "

String describing the current stage of a replication run.

" + "ReplicationRunStageDetails$stage": "

The current stage of a replication run.

" } }, "ReplicationRunStageDetails": { "base": "

Details of the current stage of a replication run.

", "refs": { - "ReplicationRun$stageDetails": "

Details of the current stage of the replication run.

" + "ReplicationRun$stageDetails": "

Details about the current stage of the replication run.

" } }, "ReplicationRunStageProgress": { "base": null, "refs": { - "ReplicationRunStageDetails$stageProgress": "

String describing the progress of the current stage of a replication run.

" + "ReplicationRunStageDetails$stageProgress": "

The progress of the current stage of a replication run.

" } }, "ReplicationRunState": { @@ -723,44 +884,83 @@ "RoleName": { "base": null, "refs": { - "AppSummary$roleName": "

Name of the service role in the customer's account used by AWS SMS.

", - "CreateAppRequest$roleName": "

Name of service role in customer's account to be used by AWS SMS.

", + "AppSummary$roleName": "

The name of the service role in the customer's account used by AWS SMS.

", + "CreateAppRequest$roleName": "

The name of the service role in the customer's account to be used by AWS SMS.

", "CreateReplicationJobRequest$roleName": "

The name of the IAM role to be used by the AWS SMS.

", - "GetAppLaunchConfigurationResponse$roleName": "

Name of the service role in the customer's account that Amazon CloudFormation uses to launch the application.

", - "PutAppLaunchConfigurationRequest$roleName": "

Name of service role in the customer's account that Amazon CloudFormation uses to launch the application.

", - "ReplicationJob$roleName": "

The name of the IAM role to be used by the Server Migration Service.

", - "UpdateAppRequest$roleName": "

Name of the service role in the customer's account used by AWS SMS.

", + "GetAppLaunchConfigurationResponse$roleName": "

The name of the service role in the customer's account that AWS CloudFormation uses to launch the application.

", + "ImportAppCatalogRequest$roleName": "

The name of the service role. If you omit this parameter, we create a service-linked role for AWS Migration Hub in your account. Otherwise, the role that you provide must have the policy and trust policy described in the AWS Migration Hub User Guide.

", + "PutAppLaunchConfigurationRequest$roleName": "

The name of service role in the customer's account that AWS CloudFormation uses to launch the application.

", + "ReplicationJob$roleName": "

The name of the IAM role to be used by AWS SMS.

", + "ServerLaunchConfiguration$iamInstanceProfileName": "

The name of the IAM instance profile.

", + "UpdateAppRequest$roleName": "

The name of the service role in the customer's account used by AWS SMS.

", "UpdateReplicationJobRequest$roleName": "

The name of the IAM role to be used by AWS SMS.

" } }, "RunOnce": { "base": null, "refs": { - "CreateReplicationJobRequest$runOnce": "

", - "ReplicationJob$runOnce": "

", - "ServerReplicationParameters$runOnce": "

" + "CreateReplicationJobRequest$runOnce": "

Indicates whether to run the replication job one time.

", + "ReplicationJob$runOnce": "

Indicates whether to run the replication job one time.

", + "ServerReplicationParameters$runOnce": "

Indicates whether to run the replication job one time.

" + } + }, + "S3BucketName": { + "base": null, + "refs": { + "S3Location$bucket": "

The Amazon S3 bucket name.

" + } + }, + "S3KeyName": { + "base": null, + "refs": { + "S3Location$key": "

The Amazon S3 bucket key.

" } }, "S3Location": { - "base": "

Location of the Amazon S3 object in the customer's account.

", + "base": "

Location of an Amazon S3 object.

", "refs": { - "GenerateChangeSetResponse$s3Location": "

Location of the Amazon S3 object.

", - "GenerateTemplateResponse$s3Location": "

Location of the Amazon S3 object.

", + "GenerateChangeSetResponse$s3Location": "

The location of the Amazon S3 object.

", + "GenerateTemplateResponse$s3Location": "

The location of the Amazon S3 object.

", + "SSMOutput$s3Location": null, + "ServerLaunchConfiguration$configureScript": null, + "Source$s3Location": null, "UserData$s3Location": "

Amazon S3 location of the user-data script.

" } }, + "SSMOutput": { + "base": "

Contains the location of validation output.

", + "refs": { + "AppValidationOutput$ssmOutput": "

Output from using SSM to validate the application.

" + } + }, + "SSMValidationParameters": { + "base": "

Contains validation parameters.

", + "refs": { + "AppValidationConfiguration$ssmValidationParameters": "

The validation parameters.

" + } + }, + "ScriptType": { + "base": null, + "refs": { + "SSMValidationParameters$scriptType": "

The type of validation script.

", + "ServerLaunchConfiguration$configureScriptType": "

The type of configuration script.

", + "UserDataValidationParameters$scriptType": "

The type of validation script.

" + } + }, "SecurityGroup": { "base": null, "refs": { - "ServerLaunchConfiguration$securityGroup": "

Identifier of the security group that applies to the launched server.

" + "ServerLaunchConfiguration$securityGroup": "

The ID of the security group that applies to the launched server.

" } }, "Server": { "base": "

Represents a server.

", "refs": { - "ServerLaunchConfiguration$server": "

Identifier of the server the launch configuration is associated with.

", + "ServerLaunchConfiguration$server": "

The ID of the server with which the launch configuration is associated.

", "ServerList$member": null, - "ServerReplicationConfiguration$server": "

Identifier of the server this replication configuration is associated with.

" + "ServerReplicationConfiguration$server": "

The ID of the server with which this replication configuration is associated.

", + "ServerValidationConfiguration$server": null, + "ServerValidationOutput$server": null } }, "ServerCannotBeReplicatedException": { @@ -775,7 +975,7 @@ } }, "ServerGroup": { - "base": "

A logical grouping of servers.

", + "base": "

Logical grouping of servers.

", "refs": { "ServerGroups$member": null } @@ -783,9 +983,10 @@ "ServerGroupId": { "base": null, "refs": { - "ServerGroup$serverGroupId": "

Identifier of a server group.

", - "ServerGroupLaunchConfiguration$serverGroupId": "

Identifier of the server group the launch configuration is associated with.

", - "ServerGroupReplicationConfiguration$serverGroupId": "

Identifier of the server group this replication configuration is associated with.

" + "ServerGroup$serverGroupId": "

The ID of a server group.

", + "ServerGroupLaunchConfiguration$serverGroupId": "

The ID of the server group with which the launch configuration is associated.

", + "ServerGroupReplicationConfiguration$serverGroupId": "

The ID of the server group with which this replication configuration is associated.

", + "ServerGroupValidationConfiguration$serverGroupId": "

The ID of the server group.

" } }, "ServerGroupLaunchConfiguration": { @@ -797,14 +998,14 @@ "ServerGroupLaunchConfigurations": { "base": null, "refs": { - "GetAppLaunchConfigurationResponse$serverGroupLaunchConfigurations": "

List of launch configurations for server groups in this application.

", - "PutAppLaunchConfigurationRequest$serverGroupLaunchConfigurations": "

Launch configurations for server groups in the application.

" + "GetAppLaunchConfigurationResponse$serverGroupLaunchConfigurations": "

The launch configurations for server groups in this application.

", + "PutAppLaunchConfigurationRequest$serverGroupLaunchConfigurations": "

Information about the launch configurations for server groups in the application.

" } }, "ServerGroupName": { "base": null, "refs": { - "ServerGroup$name": "

Name of a server group.

" + "ServerGroup$name": "

The name of a server group.

" } }, "ServerGroupReplicationConfiguration": { @@ -816,26 +1017,39 @@ "ServerGroupReplicationConfigurations": { "base": null, "refs": { - "GetAppReplicationConfigurationResponse$serverGroupReplicationConfigurations": "

Replication configurations associated with server groups in this application.

", - "PutAppReplicationConfigurationRequest$serverGroupReplicationConfigurations": "

Replication configurations for server groups in the application.

" + "GetAppReplicationConfigurationResponse$serverGroupReplicationConfigurations": "

The replication configurations associated with server groups in this application.

", + "PutAppReplicationConfigurationRequest$serverGroupReplicationConfigurations": "

Information about the replication configurations for server groups in the application.

" + } + }, + "ServerGroupValidationConfiguration": { + "base": "

Configuration for validating an instance.

", + "refs": { + "ServerGroupValidationConfigurations$member": null + } + }, + "ServerGroupValidationConfigurations": { + "base": null, + "refs": { + "GetAppValidationConfigurationResponse$serverGroupValidationConfigurations": "

The configuration for instance validation.

", + "PutAppValidationConfigurationRequest$serverGroupValidationConfigurations": "

The configuration for instance validation.

" } }, "ServerGroups": { "base": null, "refs": { - "CreateAppRequest$serverGroups": "

List of server groups to include in the application.

", - "CreateAppResponse$serverGroups": "

List of server groups included in the application.

", - "GetAppResponse$serverGroups": "

List of server groups belonging to the application.

", - "UpdateAppRequest$serverGroups": "

List of server groups in the application to update.

", - "UpdateAppResponse$serverGroups": "

List of updated server groups in the application.

" + "CreateAppRequest$serverGroups": "

The server groups to include in the application.

", + "CreateAppResponse$serverGroups": "

The server groups included in the application.

", + "GetAppResponse$serverGroups": "

The server groups that belong to the application.

", + "UpdateAppRequest$serverGroups": "

The server groups in the application to update.

", + "UpdateAppResponse$serverGroups": "

The updated server groups in the application.

" } }, "ServerId": { "base": null, "refs": { - "CreateReplicationJobRequest$serverId": "

The identifier of the server.

", - "ReplicationJob$serverId": "

The identifier of the server.

", - "Server$serverId": "

The identifier of the server.

" + "CreateReplicationJobRequest$serverId": "

The ID of the server.

", + "ReplicationJob$serverId": "

The ID of the server.

", + "Server$serverId": "

The ID of the server.

" } }, "ServerLaunchConfiguration": { @@ -847,14 +1061,14 @@ "ServerLaunchConfigurations": { "base": null, "refs": { - "ServerGroupLaunchConfiguration$serverLaunchConfigurations": "

Launch configuration for servers in the server group.

" + "ServerGroupLaunchConfiguration$serverLaunchConfigurations": "

The launch configuration for servers in the server group.

" } }, "ServerList": { "base": null, "refs": { "GetServersResponse$serverList": "

Information about the servers.

", - "ServerGroup$serverList": "

List of servers belonging to a server group.

" + "ServerGroup$serverList": "

The servers that belong to a server group.

" } }, "ServerReplicationConfiguration": { @@ -866,13 +1080,13 @@ "ServerReplicationConfigurations": { "base": null, "refs": { - "ServerGroupReplicationConfiguration$serverReplicationConfigurations": "

Replication configuration for servers in the server group.

" + "ServerGroupReplicationConfiguration$serverReplicationConfigurations": "

The replication configuration for servers in the server group.

" } }, "ServerReplicationParameters": { - "base": "

Replication parameters for replicating a server.

", + "base": "

The replication parameters for replicating a server.

", "refs": { - "ServerReplicationConfiguration$serverReplicationParameters": "

Parameters for replicating the server.

" + "ServerReplicationConfiguration$serverReplicationParameters": "

The parameters for replicating the server.

" } }, "ServerType": { @@ -882,16 +1096,47 @@ "Server$serverType": "

The type of server.

" } }, + "ServerValidationConfiguration": { + "base": "

Configuration for validating an instance.

", + "refs": { + "ServerValidationConfigurations$member": null + } + }, + "ServerValidationConfigurations": { + "base": null, + "refs": { + "ServerGroupValidationConfiguration$serverValidationConfigurations": "

The validation configuration.

" + } + }, + "ServerValidationOutput": { + "base": "

Contains output from validating an instance.

", + "refs": { + "ValidationOutput$serverValidationOutput": "

The output from validation an instance.

" + } + }, + "ServerValidationStrategy": { + "base": null, + "refs": { + "ServerValidationConfiguration$serverValidationStrategy": "

The validation strategy.

" + } + }, + "Source": { + "base": "

Contains the location of a validation script.

", + "refs": { + "SSMValidationParameters$source": "

The location of the validation script.

", + "UserDataValidationParameters$source": "

The location of the validation script.

" + } + }, "StackId": { "base": null, "refs": { - "LaunchDetails$stackId": "

Identifier of the latest stack launched for this application.

" + "LaunchDetails$stackId": "

The ID of the latest stack launched for this application.

" } }, "StackName": { "base": null, "refs": { - "LaunchDetails$stackName": "

Name of the latest stack launched for this application.

" + "LaunchDetails$stackName": "

The name of the latest stack launched for this application.

" } }, "StartAppReplicationRequest": { @@ -904,6 +1149,16 @@ "refs": { } }, + "StartOnDemandAppReplicationRequest": { + "base": null, + "refs": { + } + }, + "StartOnDemandAppReplicationResponse": { + "base": null, + "refs": { + } + }, "StartOnDemandReplicationRunRequest": { "base": null, "refs": { @@ -927,11 +1182,11 @@ "Subnet": { "base": null, "refs": { - "ServerLaunchConfiguration$subnet": "

Identifier of the subnet the server should be launched into.

" + "ServerLaunchConfiguration$subnet": "

The ID of the subnet the server should be launched into.

" } }, "Tag": { - "base": "

A label that can be assigned to an application.

", + "base": "

Key/value pair that can be assigned to an application.

", "refs": { "Tags$member": null } @@ -939,23 +1194,23 @@ "TagKey": { "base": null, "refs": { - "Tag$key": "

Tag key.

" + "Tag$key": "

The tag key.

" } }, "TagValue": { "base": null, "refs": { - "Tag$value": "

Tag value.

" + "Tag$value": "

The tag value.

" } }, "Tags": { "base": null, "refs": { - "CreateAppRequest$tags": "

List of tags to be associated with the application.

", - "CreateAppResponse$tags": "

List of taags associated with the application.

", - "GetAppResponse$tags": "

List of tags associated with the application.

", - "UpdateAppRequest$tags": "

List of tags to associate with the application.

", - "UpdateAppResponse$tags": "

List of tags associated with the application.

" + "CreateAppRequest$tags": "

The tags to be associated with the application.

", + "CreateAppResponse$tags": "

The tags associated with the application.

", + "GetAppResponse$tags": "

The tags associated with the application.

", + "UpdateAppRequest$tags": "

The tags to associate with the application.

", + "UpdateAppResponse$tags": "

The tags associated with the application.

" } }, "TemporarilyUnavailableException": { @@ -976,31 +1231,32 @@ "Timestamp": { "base": null, "refs": { - "AppSummary$latestReplicationTime": "

Timestamp of the application's most recent successful replication.

", - "AppSummary$creationTime": "

Time of creation of this application.

", - "AppSummary$lastModified": "

Timestamp of the application's creation.

", + "AppSummary$latestReplicationTime": "

The timestamp of the application's most recent successful replication.

", + "AppSummary$creationTime": "

The creation time of the application.

", + "AppSummary$lastModified": "

The last modified time of the application.

", "Connector$associatedOn": "

The time the connector was associated.

", "CreateReplicationJobRequest$seedReplicationTime": "

The seed replication time.

", "GetServersResponse$lastModifiedOn": "

The time when the server was last modified.

", - "LaunchDetails$latestLaunchTime": "

Latest time this application was launched successfully.

", + "LaunchDetails$latestLaunchTime": "

The latest time that this application was launched successfully.

", "ReplicationJob$seedReplicationTime": "

The seed replication time.

", "ReplicationJob$nextReplicationRunStartTime": "

The start time of the next replication run.

", "ReplicationRun$scheduledStartTime": "

The start time of the next replication run.

", "ReplicationRun$completedTime": "

The completion time of the last replication run.

", - "ServerReplicationParameters$seedTime": "

Seed time for creating a replication job for the server.

", - "UpdateReplicationJobRequest$nextReplicationRunStartTime": "

The start time of the next replication run.

" + "ServerReplicationParameters$seedTime": "

The seed time for creating a replication job for the server.

", + "UpdateReplicationJobRequest$nextReplicationRunStartTime": "

The start time of the next replication run.

", + "ValidationOutput$latestValidationTime": "

The latest time that the validation was performed.

" } }, "TotalServerGroups": { "base": null, "refs": { - "AppSummary$totalServerGroups": "

Number of server groups present in the application.

" + "AppSummary$totalServerGroups": "

The number of server groups present in the application.

" } }, "TotalServers": { "base": null, "refs": { - "AppSummary$totalServers": "

Number of servers present in the application.

" + "AppSummary$totalServers": "

The number of servers present in the application.

" } }, "UnauthorizedOperationException": { @@ -1034,23 +1290,64 @@ "ServerLaunchConfiguration$userData": "

Location of the user-data script to be executed when launching the server.

" } }, + "UserDataValidationParameters": { + "base": "

Contains validation parameters.

", + "refs": { + "ServerValidationConfiguration$userDataValidationParameters": "

The validation parameters.

" + } + }, "VPC": { "base": null, "refs": { - "ServerLaunchConfiguration$vpc": "

Identifier of the VPC the server should be launched into.

" + "ServerLaunchConfiguration$vpc": "

The ID of the VPC into which the server should be launched.

" + } + }, + "ValidationId": { + "base": null, + "refs": { + "AppValidationConfiguration$validationId": "

The ID of the validation.

", + "NotificationContext$validationId": "

The ID of the validation.

", + "ServerValidationConfiguration$validationId": "

The ID of the validation.

", + "ValidationOutput$validationId": "

The ID of the validation.

" + } + }, + "ValidationOutput": { + "base": "

Contains validation output.

", + "refs": { + "ValidationOutputList$member": null + } + }, + "ValidationOutputList": { + "base": null, + "refs": { + "GetAppValidationOutputResponse$validationOutputList": "

The validation output.

" + } + }, + "ValidationStatus": { + "base": null, + "refs": { + "NotificationContext$status": "

The status of the validation.

", + "ValidationOutput$status": "

The status of the validation.

" + } + }, + "ValidationStatusMessage": { + "base": null, + "refs": { + "NotificationContext$statusMessage": "

The status message.

", + "ValidationOutput$statusMessage": "

The status message.

" } }, "VmId": { "base": null, "refs": { - "VmServerAddress$vmId": "

The identifier of the VM.

" + "VmServerAddress$vmId": "

The ID of the VM.

" } }, "VmManagerId": { "base": null, "refs": { - "Connector$vmManagerId": "

The identifier of the VM manager.

", - "VmServerAddress$vmManagerId": "

The identifier of the VM manager.

" + "Connector$vmManagerId": "

The ID of the VM manager.

", + "VmServerAddress$vmManagerId": "

The ID of the VM manager.

" } }, "VmManagerName": { @@ -1089,14 +1386,14 @@ "VmServerAddress": { "base": "

Represents a VM server location.

", "refs": { - "VmServer$vmServerAddress": "

Information about the VM server location.

", + "VmServer$vmServerAddress": "

The VM server location.

", "VmServerAddressList$member": null } }, "VmServerAddressList": { "base": null, "refs": { - "GetServersRequest$vmServerAddressList": "

List of VmServerAddress objects

" + "GetServersRequest$vmServerAddressList": "

The server addresses.

" } } } diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index e06302ffb12..8e40e0c37aa 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -1954,6 +1954,7 @@ "protocols" : [ "http", "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -1963,6 +1964,7 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -3781,6 +3783,12 @@ }, "neptune" : { "endpoints" : { + "ap-east-1" : { + "credentialScope" : { + "region" : "ap-east-1" + }, + "hostname" : "rds.ap-east-1.amazonaws.com" + }, "ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" @@ -3853,6 +3861,12 @@ }, "hostname" : "rds.me-south-1.amazonaws.com" }, + "sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "rds.sa-east-1.amazonaws.com" + }, "us-east-1" : { "credentialScope" : { "region" : "us-east-1" diff --git a/service/glue/api.go b/service/glue/api.go index 2983b94b3c9..7800c82dfc8 100644 --- a/service/glue/api.go +++ b/service/glue/api.go @@ -16459,6 +16459,9 @@ type ConnectionInput struct { // // * MONGODB - Designates a connection to a MongoDB document database. // + // * NETWORK - Designates a network connection to a data source within an + // Amazon Virtual Private Cloud environment (Amazon VPC). + // // SFTP is not supported. // // ConnectionType is a required field @@ -31277,6 +31280,10 @@ func (s *S3Encryption) SetS3EncryptionMode(v string) *S3Encryption { type S3Target struct { _ struct{} `type:"structure"` + // The name of a connection which allows a job or crawler to access data in + // Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC). + ConnectionName *string `type:"string"` + // A list of glob patterns used to exclude from the crawl. For more information, // see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html). Exclusions []*string `type:"list"` @@ -31295,6 +31302,12 @@ func (s S3Target) GoString() string { return s.String() } +// SetConnectionName sets the ConnectionName field's value. +func (s *S3Target) SetConnectionName(v string) *S3Target { + s.ConnectionName = &v + return s +} + // SetExclusions sets the Exclusions field's value. func (s *S3Target) SetExclusions(v []*string) *S3Target { s.Exclusions = v @@ -37449,6 +37462,9 @@ const ( // ConnectionTypeKafka is a ConnectionType enum value ConnectionTypeKafka = "KAFKA" + + // ConnectionTypeNetwork is a ConnectionType enum value + ConnectionTypeNetwork = "NETWORK" ) const ( diff --git a/service/organizations/api.go b/service/organizations/api.go index daf37bd9392..d7aa5a7b466 100644 --- a/service/organizations/api.go +++ b/service/organizations/api.go @@ -14842,6 +14842,9 @@ type CreateAccountStatus struct { // * ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you // have reached the limit on the number of accounts in your organization. // + // * CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with + // the same information. + // // * EMAIL_ALREADY_EXISTS: The account could not be created because another // AWS account with that email address already exists. // @@ -14857,6 +14860,12 @@ type CreateAccountStatus struct { // // * INTERNAL_FAILURE: The account could not be created because of an internal // failure. Try again later. If the problem persists, contact Customer Support. + // + // * MISSING_BUSINESS_VALIDATION: The AWS account that owns your organization + // has not received Business Validation. + // + // * MISSING_PAYMENT_INSTRUMENT: You must configure the master account with + // a valid payment method, such as a credit card. FailureReason *string `type:"string" enum:"CreateAccountFailureReason"` // If the account was created successfully, the unique identifier (ID) of the @@ -22127,6 +22136,12 @@ const ( // CreateAccountFailureReasonGovcloudAccountAlreadyExists is a CreateAccountFailureReason enum value CreateAccountFailureReasonGovcloudAccountAlreadyExists = "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" + + // CreateAccountFailureReasonMissingBusinessValidation is a CreateAccountFailureReason enum value + CreateAccountFailureReasonMissingBusinessValidation = "MISSING_BUSINESS_VALIDATION" + + // CreateAccountFailureReasonMissingPaymentInstrument is a CreateAccountFailureReason enum value + CreateAccountFailureReasonMissingPaymentInstrument = "MISSING_PAYMENT_INSTRUMENT" ) const ( diff --git a/service/s3/api.go b/service/s3/api.go index 82defe7f2cf..8aadf3c56ee 100644 --- a/service/s3/api.go +++ b/service/s3/api.go @@ -75,23 +75,23 @@ func (c *S3) AbortMultipartUploadRequest(input *AbortMultipartUploadInput) (req // times in order to completely free all storage consumed by all parts. // // To verify that all parts have been removed, so you don't get charged for -// the part storage, you should call the ListParts operation and ensure that -// the parts list is empty. +// the part storage, you should call the ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) +// operation and ensure that the parts list is empty. // // For information about permissions required to use the multipart upload API, // see Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). // // The following operations are related to AbortMultipartUpload: // -// * CreateMultipartUpload +// * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) // -// * UploadPart +// * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // -// * CompleteMultipartUpload +// * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) // -// * ListParts +// * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) // -// * ListMultipartUploads +// * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -173,14 +173,15 @@ func (c *S3) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) // Completes a multipart upload by assembling previously uploaded parts. // // You first initiate the multipart upload and then upload all parts using the -// UploadPart operation. After successfully uploading all relevant parts of -// an upload, you call this operation to complete the upload. Upon receiving -// this request, Amazon S3 concatenates all the parts in ascending order by -// part number to create a new object. In the Complete Multipart Upload request, -// you must provide the parts list. You must ensure that the parts list is complete. -// This operation concatenates the parts that you provide in the list. For each -// part in the list, you must provide the part number and the ETag value, returned -// after that part was uploaded. +// UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) +// operation. After successfully uploading all relevant parts of an upload, +// you call this operation to complete the upload. Upon receiving this request, +// Amazon S3 concatenates all the parts in ascending order by part number to +// create a new object. In the Complete Multipart Upload request, you must provide +// the parts list. You must ensure that the parts list is complete. This operation +// concatenates the parts that you provide in the list. For each part in the +// list, you must provide the part number and the ETag value, returned after +// that part was uploaded. // // Processing of a Complete Multipart Upload request could take several minutes // to complete. After Amazon S3 begins processing the request, it sends an HTTP @@ -200,7 +201,7 @@ func (c *S3) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) // For information about permissions required to use the multipart upload API, // see Multipart Upload API and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). // -// GetBucketLifecycle has the following special errors: +// CompleteMultipartUpload has the following special errors: // // * Error code: EntityTooSmall Description: Your proposed upload is smaller // than the minimum allowed object size. Each part must be at least 5 MB @@ -220,15 +221,15 @@ func (c *S3) CompleteMultipartUploadRequest(input *CompleteMultipartUploadInput) // // The following operations are related to CompleteMultipartUpload: // -// * CreateMultipartUpload +// * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) // -// * UploadPart +// * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // -// * AbortMultipartUpload +// * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) // -// * ListParts +// * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) // -// * ListMultipartUploads +// * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -441,13 +442,13 @@ func (c *S3) CopyObjectRequest(input *CopyObjectInput) (req *request.Request, ou // // If the source object's storage class is GLACIER, you must restore a copy // of this object before you can use it as a source object for the copy operation. -// For more information, see . +// For more information, see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). // // The following operations are related to CopyObject: // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // // For more information, see Copying Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html). // @@ -587,9 +588,9 @@ func (c *S3) CreateBucketRequest(input *CreateBucketInput) (req *request.Request // // The following operations are related to CreateBucket: // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // -// * DeleteBucket +// * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -679,8 +680,9 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // This operation initiates a multipart upload and returns an upload ID. This // upload ID is used to associate all of the parts in the specific multipart // upload. You specify this upload ID in each of your subsequent upload part -// requests (see UploadPart). You also include this upload ID in the final request -// to either complete or abort the multipart upload request. +// requests (see UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)). +// You also include this upload ID in the final request to either complete or +// abort the multipart upload request. // // For more information about multipart uploads, see Multipart Upload Overview // (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). @@ -713,9 +715,10 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // and decrypts it when you access it. You can provide your own encryption key, // or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or // Amazon S3-managed encryption keys. If you choose to provide your own encryption -// key, the request headers you provide in UploadPart) and UploadPartCopy) requests -// must match the headers you used in the request to initiate the upload by -// using CreateMultipartUpload. +// key, the request headers you provide in UploadPart (AmazonS3/latest/API/API_UploadPart.html) +// and UploadPartCopy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) +// requests must match the headers you used in the request to initiate the upload +// by using CreateMultipartUpload. // // To perform a multipart upload with encryption using an AWS KMS CMK, the requester // must have permission to the kms:Encrypt, kms:Decrypt, kms:ReEncrypt*, kms:GenerateDataKey*, @@ -759,7 +762,7 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // * Use encryption keys managed by Amazon S3 or customer master keys (CMKs) // stored in AWS Key Management Service (AWS KMS) – If you want AWS to // manage the keys used to encrypt data, specify the following headers in -// the request. x-amz-server-side​-encryption x-amz-server-side-encryption-aws-kms-key-id +// the request. x-amz-server-side-encryption x-amz-server-side-encryption-aws-kms-key-id // x-amz-server-side-encryption-context If you specify x-amz-server-side-encryption:aws:kms, // but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon // S3 uses the AWS managed CMK in AWS KMS to protect the data. All GET and @@ -770,11 +773,10 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // // * Use customer-provided encryption keys – If you want to manage your // own encryption keys, provide all the following headers in the request. -// x-amz-server-side​-encryption​-customer-algorithm x-amz-server-side​-encryption​-customer-key -// x-amz-server-side​-encryption​-customer-key-MD5 For more information -// about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see -// Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). +// x-amz-server-side-encryption-customer-algorithm x-amz-server-side-encryption-customer-key +// x-amz-server-side-encryption-customer-key-MD5 For more information about +// server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting +// Data Using Server-Side Encryption with CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). // // Access-Control-List (ACL)-Specific Request Headers // @@ -815,15 +817,15 @@ func (c *S3) CreateMultipartUploadRequest(input *CreateMultipartUploadInput) (re // // The following operations are related to CreateMultipartUpload: // -// * UploadPart +// * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // -// * CompleteMultipartUpload +// * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) // -// * AbortMultipartUpload +// * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) // -// * ListParts +// * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) // -// * ListMultipartUploads +// * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -903,9 +905,9 @@ func (c *S3) DeleteBucketRequest(input *DeleteBucketInput) (req *request.Request // // Related Resources // -// * +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * +// * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -994,11 +996,11 @@ func (c *S3) DeleteBucketAnalyticsConfigurationRequest(input *DeleteBucketAnalyt // // The following operations are related to DeleteBucketAnalyticsConfiguration: // -// * +// * GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) // -// * +// * ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) // -// * +// * PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1084,9 +1086,9 @@ func (c *S3) DeleteBucketCorsRequest(input *DeleteBucketCorsInput) (req *request // // Related Resources: // -// * +// * PutBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) // -// * RESTOPTIONSobject +// * RESTOPTIONSobject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1175,9 +1177,9 @@ func (c *S3) DeleteBucketEncryptionRequest(input *DeleteBucketEncryptionInput) ( // // Related Resources // -// * PutBucketEncryption +// * PutBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) // -// * GetBucketEncryption +// * GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1266,11 +1268,11 @@ func (c *S3) DeleteBucketInventoryConfigurationRequest(input *DeleteBucketInvent // // Operations related to DeleteBucketInventoryConfiguration include: // -// * GetBucketInventoryConfiguration +// * GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) // -// * PutBucketInventoryConfiguration +// * PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) // -// * ListBucketInventoryConfigurations +// * ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1363,9 +1365,9 @@ func (c *S3) DeleteBucketLifecycleRequest(input *DeleteBucketLifecycleInput) (re // // Related actions include: // -// * PutBucketLifecycleConfiguration +// * PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) // -// * GetBucketLifecycleConfiguration +// * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1455,11 +1457,11 @@ func (c *S3) DeleteBucketMetricsConfigurationRequest(input *DeleteBucketMetricsC // // The following operations are related to DeleteBucketMetricsConfiguration: // -// * GetBucketMetricsConfiguration +// * GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) // -// * PutBucketMetricsConfiguration +// * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) // -// * ListBucketMetricsConfigurations +// * ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) // // * Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) // @@ -1556,9 +1558,9 @@ func (c *S3) DeleteBucketPolicyRequest(input *DeleteBucketPolicyInput) (req *req // // The following operations are related to DeleteBucketPolicy // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * DeleteObject +// * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1649,9 +1651,9 @@ func (c *S3) DeleteBucketReplicationRequest(input *DeleteBucketReplicationInput) // // The following operations are related to DeleteBucketReplication: // -// * PutBucketReplication +// * PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) // -// * GetBucketReplication +// * GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1734,9 +1736,9 @@ func (c *S3) DeleteBucketTaggingRequest(input *DeleteBucketTaggingInput) (req *r // // The following operations are related to DeleteBucketTagging: // -// * GetBucketTagging +// * GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) // -// * PutBucketTagging +// * PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1828,9 +1830,9 @@ func (c *S3) DeleteBucketWebsiteRequest(input *DeleteBucketWebsiteInput) (req *r // // The following operations are related to DeleteBucketWebsite: // -// * GetBucketWebsite +// * GetBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html) // -// * PutBucketWebsite +// * PutBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1922,14 +1924,15 @@ func (c *S3) DeleteObjectRequest(input *DeleteObjectInput) (req *request.Request // To see sample requests that use versioning, see Sample Request (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete). // // You can delete objects by explicitly calling the DELETE Object API or configure -// its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for -// you. If you want to block users or accounts from removing or deleting objects -// from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, -// and s3:PutLifeCycleConfiguration actions. +// its lifecycle (PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)) +// to enable Amazon S3 to remove them for you. If you want to block users or +// accounts from removing or deleting objects from your bucket, you must deny +// them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration +// actions. // // The following operation is related to DeleteObject: // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2015,9 +2018,9 @@ func (c *S3) DeleteObjectTaggingRequest(input *DeleteObjectTaggingInput) (req *r // // The following operations are related to DeleteBucketMetricsConfiguration: // -// * PutObjectTagging +// * PutObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) // -// * GetObjectTagging +// * GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2128,15 +2131,15 @@ func (c *S3) DeleteObjectsRequest(input *DeleteObjectsInput) (req *request.Reque // // The following operations are related to DeleteObjects: // -// * CreateMultipartUpload +// * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) // -// * UploadPart +// * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // -// * CompleteMultipartUpload +// * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) // -// * ListParts +// * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) // -// * AbortMultipartUpload +// * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2221,11 +2224,11 @@ func (c *S3) DeletePublicAccessBlockRequest(input *DeletePublicAccessBlockInput) // // * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) // -// * GetPublicAccessBlock +// * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) // -// * PutPublicAccessBlock +// * PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) // -// * GetBucketPolicyStatus +// * GetBucketPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2312,7 +2315,8 @@ func (c *S3) GetBucketAccelerateConfigurationRequest(input *GetBucketAccelerateC // in the Amazon Simple Storage Service Developer Guide. // // You set the Transfer Acceleration state of an existing bucket to Enabled -// or Suspended by using the PutBucketAccelerateConfiguration operation. +// or Suspended by using the PutBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) +// operation. // // A GET accelerate request does not return a state value for a bucket that // has no transfer acceleration state. A bucket has no Transfer Acceleration @@ -2324,7 +2328,7 @@ func (c *S3) GetBucketAccelerateConfigurationRequest(input *GetBucketAccelerateC // // Related Resources // -// * PutBucketAccelerateConfiguration +// * PutBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2406,7 +2410,7 @@ func (c *S3) GetBucketAclRequest(input *GetBucketAclInput) (req *request.Request // // Related Resources // -// * +// * ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2496,11 +2500,11 @@ func (c *S3) GetBucketAnalyticsConfigurationRequest(input *GetBucketAnalyticsCon // // Related Resources // -// * +// * DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) // -// * +// * ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) // -// * +// * PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2585,9 +2589,9 @@ func (c *S3) GetBucketCorsRequest(input *GetBucketCorsInput) (req *request.Reque // // The following operations are related to GetBucketCors: // -// * PutBucketCors +// * PutBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) // -// * DeleteBucketCors +// * DeleteBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2673,9 +2677,9 @@ func (c *S3) GetBucketEncryptionRequest(input *GetBucketEncryptionInput) (req *r // // The following operations are related to GetBucketEncryption: // -// * PutBucketEncryption +// * PutBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) // -// * DeleteBucketEncryption +// * DeleteBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2763,11 +2767,11 @@ func (c *S3) GetBucketInventoryConfigurationRequest(input *GetBucketInventoryCon // // The following operations are related to GetBucketInventoryConfiguration: // -// * DeleteBucketInventoryConfiguration +// * DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) // -// * ListBucketInventoryConfigurations +// * ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) // -// * PutBucketInventoryConfiguration +// * PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2847,7 +2851,7 @@ func (c *S3) GetBucketLifecycleRequest(input *GetBucketLifecycleInput) (req *req // GetBucketLifecycle API operation for Amazon Simple Storage Service. // // -// For an updated version of this API, see GetBucketLifecycleConfiguration. +// For an updated version of this API, see GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html). // If you configured a bucket lifecycle using the filter element, you should // see the updated version of this topic. This topic is provided for backward // compatibility. @@ -2869,11 +2873,11 @@ func (c *S3) GetBucketLifecycleRequest(input *GetBucketLifecycleInput) (req *req // // The following operations are related to GetBucketLifecycle: // -// * GetBucketLifecycleConfiguration +// * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) // -// * PutBucketLifecycle +// * PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) // -// * DeleteBucketLifecycle +// * DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2958,7 +2962,7 @@ func (c *S3) GetBucketLifecycleConfigurationRequest(input *GetBucketLifecycleCon // the new filter element that you can use to specify a filter to select a subset // of objects to which the rule applies. If you are still using previous version // of the lifecycle configuration, it works. For the earlier API description, -// see GetBucketLifecycle. +// see GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html). // // Returns the lifecycle configuration information set on the bucket. For information // about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html). @@ -2977,11 +2981,11 @@ func (c *S3) GetBucketLifecycleConfigurationRequest(input *GetBucketLifecycleCon // // The following operations are related to GetBucketLifecycleConfiguration: // -// * GetBucketLifecycle +// * GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html) // -// * PutBucketLifecycle +// * PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) // -// * DeleteBucketLifecycle +// * DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3057,15 +3061,15 @@ func (c *S3) GetBucketLocationRequest(input *GetBucketLocationInput) (req *reque // // Returns the Region the bucket resides in. You set the bucket's Region using // the LocationConstraint request parameter in a CreateBucket request. For more -// information, see CreateBucket. +// information, see CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). // // To use this implementation of the operation, you must be the bucket owner. // // The following operations are related to GetBucketLocation: // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3144,9 +3148,9 @@ func (c *S3) GetBucketLoggingRequest(input *GetBucketLoggingInput) (req *request // // The following operations are related to GetBucketLogging: // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * PutBucketLogging +// * PutBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3234,11 +3238,11 @@ func (c *S3) GetBucketMetricsConfigurationRequest(input *GetBucketMetricsConfigu // // The following operations are related to GetBucketMetricsConfiguration: // -// * PutBucketMetricsConfiguration +// * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) // -// * DeleteBucketMetricsConfiguration +// * DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) // -// * ListBucketMetricsConfigurations +// * ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) // // * Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) // @@ -3319,7 +3323,7 @@ func (c *S3) GetBucketNotificationRequest(input *GetBucketNotificationConfigurat // GetBucketNotification API operation for Amazon Simple Storage Service. // -// No longer used, see GetBucketNotificationConfiguration. +// No longer used, see GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3413,7 +3417,7 @@ func (c *S3) GetBucketNotificationConfigurationRequest(input *GetBucketNotificat // // The following operation is related to GetBucketNotification: // -// * PutBucketNotification +// * PutBucketNotification (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3506,7 +3510,7 @@ func (c *S3) GetBucketPolicyRequest(input *GetBucketPolicyInput) (req *request.R // // The following operation is related to GetBucketPolicy: // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3592,11 +3596,11 @@ func (c *S3) GetBucketPolicyStatusRequest(input *GetBucketPolicyStatusInput) (re // // * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) // -// * GetPublicAccessBlock +// * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) // -// * PutPublicAccessBlock +// * PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) // -// * DeletePublicAccessBlock +// * DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3687,13 +3691,14 @@ func (c *S3) GetBucketReplicationRequest(input *GetBucketReplicationInput) (req // also include the DeleteMarkerReplication and Priority elements. The response // also returns those elements. // -// For information about GetBucketReplication errors, see ReplicationErrorCodeList +// For information about GetBucketReplication errors, see List of replication-related +// error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) // // The following operations are related to GetBucketReplication: // -// * PutBucketReplication +// * PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) // -// * DeleteBucketReplication +// * DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3773,7 +3778,7 @@ func (c *S3) GetBucketRequestPaymentRequest(input *GetBucketRequestPaymentInput) // // The following operations are related to GetBucketRequestPayment: // -// * ListObjects +// * ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3860,9 +3865,9 @@ func (c *S3) GetBucketTaggingRequest(input *GetBucketTaggingInput) (req *request // // The following operations are related to GetBucketTagging: // -// * PutBucketTagging +// * PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) // -// * DeleteBucketTagging +// * DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3946,11 +3951,11 @@ func (c *S3) GetBucketVersioningRequest(input *GetBucketVersioningInput) (req *r // // The following operations are related to GetBucketVersioning: // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // -// * DeleteObject +// * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4036,9 +4041,9 @@ func (c *S3) GetBucketWebsiteRequest(input *GetBucketWebsiteInput) (req *request // // The following operations are related to DeleteBucketWebsite: // -// * DeleteBucketWebsite +// * DeleteBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html) // -// * PutBucketWebsite +// * PutBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4132,13 +4137,14 @@ func (c *S3) GetObjectRequest(input *GetObjectInput) (req *request.Request, outp // // To distribute large files to many people, you can save bandwidth costs by // using BitTorrent. For more information, see Amazon S3 Torrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html). -// For more information about returning the ACL of an object, see GetObjectAcl. +// For more information about returning the ACL of an object, see GetObjectAcl +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html). // // If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE // storage classes, before you can retrieve the object you must first restore -// a copy using . Otherwise, this operation returns an InvalidObjectStateError -// error. For information about restoring archived objects, see Restoring Archived -// Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html). +// a copy using RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). +// Otherwise, this operation returns an InvalidObjectStateError error. For information +// about restoring archived objects, see Restoring Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html). // // Encryption request headers, like x-amz-server-side-encryption, should not // be sent for GET requests if your object uses server-side encryption with @@ -4150,11 +4156,11 @@ func (c *S3) GetObjectRequest(input *GetObjectInput) (req *request.Request, outp // encryption keys (SSE-C) when you store the object in Amazon S3, then when // you GET the object, you must use the following headers: // -// * x-amz-server-side​-encryption​-customer-algorithm +// * x-amz-server-side-encryption-customer-algorithm // -// * x-amz-server-side​-encryption​-customer-key +// * x-amz-server-side-encryption-customer-key // -// * x-amz-server-side​-encryption​-customer-key-MD5 +// * x-amz-server-side-encryption-customer-key-MD5 // // For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided // Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). @@ -4162,6 +4168,7 @@ func (c *S3) GetObjectRequest(input *GetObjectInput) (req *request.Request, outp // Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging // action), the response also returns the x-amz-tagging-count header that provides // the count of number of tags associated with the object. You can use GetObjectTagging +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) // to retrieve the tag set associated with an object. // // Permissions @@ -4186,7 +4193,7 @@ func (c *S3) GetObjectRequest(input *GetObjectInput) (req *request.Request, outp // as if the object was deleted and includes x-amz-delete-marker: true in the // response. // -// For more information about versioning, see PutBucketVersioning. +// For more information about versioning, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html). // // Overriding Response Header Values // @@ -4233,9 +4240,9 @@ func (c *S3) GetObjectRequest(input *GetObjectInput) (req *request.Request, outp // // The following operations are related to GetObject: // -// * ListBuckets +// * ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) // -// * GetObjectAcl +// * GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4324,11 +4331,11 @@ func (c *S3) GetObjectAclRequest(input *GetObjectAclInput) (req *request.Request // // The following operations are related to GetObjectAcl: // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * DeleteObject +// * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4652,7 +4659,7 @@ func (c *S3) GetObjectTaggingRequest(input *GetObjectTaggingInput) (req *request // // The following operation is related to GetObjectTagging: // -// * PutObjectTagging +// * PutObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4738,7 +4745,7 @@ func (c *S3) GetObjectTorrentRequest(input *GetObjectTorrentInput) (req *request // // The following operation is related to GetObjectTorrent: // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4831,11 +4838,11 @@ func (c *S3) GetPublicAccessBlockRequest(input *GetPublicAccessBlockInput) (req // // * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) // -// * PutPublicAccessBlock +// * PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) // -// * GetPublicAccessBlock +// * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) // -// * DeletePublicAccessBlock +// * DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5010,11 +5017,11 @@ func (c *S3) HeadObjectRequest(input *HeadObjectInput) (req *request.Request, ou // encryption keys (SSE-C) when you store the object in Amazon S3, then when // you retrieve the metadata from the object, you must use the following headers: // -// * x-amz-server-side​-encryption​-customer-algorithm +// * x-amz-server-side-encryption-customer-algorithm // -// * x-amz-server-side​-encryption​-customer-key +// * x-amz-server-side-encryption-customer-key // -// * x-amz-server-side​-encryption​-customer-key-MD5 +// * x-amz-server-side-encryption-customer-key-MD5 // // For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided // Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). @@ -5057,7 +5064,7 @@ func (c *S3) HeadObjectRequest(input *HeadObjectInput) (req *request.Request, ou // // The following operation is related to HeadObject: // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // // See http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses // for more information on returned errors. @@ -5156,11 +5163,11 @@ func (c *S3) ListBucketAnalyticsConfigurationsRequest(input *ListBucketAnalytics // // The following operations are related to ListBucketAnalyticsConfigurations: // -// * GetBucketAnalyticsConfiguration +// * GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) // -// * DeleteBucketAnalyticsConfiguration +// * DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) // -// * PutBucketAnalyticsConfiguration +// * PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5256,11 +5263,11 @@ func (c *S3) ListBucketInventoryConfigurationsRequest(input *ListBucketInventory // // The following operations are related to ListBucketInventoryConfigurations: // -// * GetBucketInventoryConfiguration +// * GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) // -// * DeleteBucketInventoryConfiguration +// * DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) // -// * PutBucketInventoryConfiguration +// * PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5357,11 +5364,11 @@ func (c *S3) ListBucketMetricsConfigurationsRequest(input *ListBucketMetricsConf // // The following operations are related to ListBucketMetricsConfigurations: // -// * PutBucketMetricsConfiguration +// * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) // -// * GetBucketMetricsConfiguration +// * GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) // -// * DeleteBucketMetricsConfiguration +// * DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5540,15 +5547,15 @@ func (c *S3) ListMultipartUploadsRequest(input *ListMultipartUploadsInput) (req // // The following operations are related to ListMultipartUploads: // -// * CreateMultipartUpload +// * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) // -// * UploadPart +// * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // -// * CompleteMultipartUpload +// * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) // -// * ListParts +// * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) // -// * AbortMultipartUpload +// * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5691,13 +5698,13 @@ func (c *S3) ListObjectVersionsRequest(input *ListObjectVersionsInput) (req *req // // The following operations are related to ListObjectVersions: // -// * ListObjectsV2 +// * ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // -// * DeleteObject +// * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5835,21 +5842,22 @@ func (c *S3) ListObjectsRequest(input *ListObjectsInput) (req *request.Request, // to design your application to parse the contents of the response and handle // it appropriately. // -// This API has been revised. We recommend that you use the newer version, ListObjectsV2, +// This API has been revised. We recommend that you use the newer version, ListObjectsV2 +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html), // when developing applications. For backward compatibility, Amazon S3 continues // to support ListObjects. // // The following operations are related to ListObjects: // -// * ListObjectsV2 +// * ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * ListBuckets +// * ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6003,17 +6011,18 @@ func (c *S3) ListObjectsV2Request(input *ListObjectsV2Input) (req *request.Reque // // This section describes the latest revision of the API. We recommend that // you use this revised API for application development. For backward compatibility, -// Amazon S3 continues to support the prior version of this API, ListObjects. +// Amazon S3 continues to support the prior version of this API, ListObjects +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html). // -// To get a list of your buckets, see ListBuckets. +// To get a list of your buckets, see ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html). // // The following operations are related to ListObjectsV2: // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6152,14 +6161,14 @@ func (c *S3) ListPartsRequest(input *ListPartsInput) (req *request.Request, outp // // Lists the parts that have been uploaded for a specific multipart upload. // This operation must include the upload ID, which you obtain by sending the -// initiate multipart upload request (see CreateMultipartUpload). This request -// returns a maximum of 1,000 uploaded parts. The default number of parts returned -// is 1,000 parts. You can restrict the number of parts returned by specifying -// the max-parts request parameter. If your multipart upload consists of more -// than 1,000 parts, the response returns an IsTruncated field with the value -// of true, and a NextPartNumberMarker element. In subsequent ListParts requests -// you can include the part-number-marker query string parameter and set its -// value to the NextPartNumberMarker field value from the previous response. +// initiate multipart upload request (see CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)). +// This request returns a maximum of 1,000 uploaded parts. The default number +// of parts returned is 1,000 parts. You can restrict the number of parts returned +// by specifying the max-parts request parameter. If your multipart upload consists +// of more than 1,000 parts, the response returns an IsTruncated field with +// the value of true, and a NextPartNumberMarker element. In subsequent ListParts +// requests you can include the part-number-marker query string parameter and +// set its value to the NextPartNumberMarker field value from the previous response. // // For more information on multipart uploads, see Uploading Objects Using Multipart // Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). @@ -6169,15 +6178,15 @@ func (c *S3) ListPartsRequest(input *ListPartsInput) (req *request.Request, outp // // The following operations are related to ListParts: // -// * CreateMultipartUpload +// * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) // -// * UploadPart +// * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // -// * CompleteMultipartUpload +// * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) // -// * AbortMultipartUpload +// * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) // -// * ListMultipartUploads +// * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6321,8 +6330,8 @@ func (c *S3) PutBucketAccelerateConfigurationRequest(input *PutBucketAccelerateC // // * Suspended – Disables accelerated data transfers to the bucket. // -// The GetBucketAccelerateConfiguration operation returns the transfer acceleration -// state of a bucket. +// The GetBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) +// operation returns the transfer acceleration state of a bucket. // // After setting the Transfer Acceleration state of a bucket to Enabled, it // might take up to thirty minutes before the data transfer rates to the bucket @@ -6336,9 +6345,9 @@ func (c *S3) PutBucketAccelerateConfigurationRequest(input *PutBucketAccelerateC // // The following operations are related to PutBucketAccelerateConfiguration: // -// * GetBucketAccelerateConfiguration +// * GetBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6498,11 +6507,11 @@ func (c *S3) PutBucketAclRequest(input *PutBucketAclInput) (req *request.Request // // Related Resources // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * DeleteBucket +// * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) // -// * GetObjectAcl +// * GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6617,11 +6626,11 @@ func (c *S3) PutBucketAnalyticsConfigurationRequest(input *PutBucketAnalyticsCon // // Related Resources // -// * +// * GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) // -// * +// * DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) // -// * +// * ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6738,11 +6747,11 @@ func (c *S3) PutBucketCorsRequest(input *PutBucketCorsInput) (req *request.Reque // // Related Resources // -// * GetBucketCors +// * GetBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html) // -// * DeleteBucketCors +// * DeleteBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) // -// * RESTOPTIONSobject +// * RESTOPTIONSobject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6841,9 +6850,9 @@ func (c *S3) PutBucketEncryptionRequest(input *PutBucketEncryptionInput) (req *r // // Related Resources // -// * GetBucketEncryption +// * GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) // -// * DeleteBucketEncryption +// * DeleteBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6961,11 +6970,11 @@ func (c *S3) PutBucketInventoryConfigurationRequest(input *PutBucketInventoryCon // // Related Resources // -// * GetBucketInventoryConfiguration +// * GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) // -// * DeleteBucketInventoryConfiguration +// * DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) // -// * ListBucketInventoryConfigurations +// * ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7050,7 +7059,7 @@ func (c *S3) PutBucketLifecycleRequest(input *PutBucketLifecycleInput) (req *req // PutBucketLifecycle API operation for Amazon Simple Storage Service. // // -// For an updated version of this API, see PutBucketLifecycleConfiguration. +// For an updated version of this API, see PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html). // This version has been deprecated. Existing lifecycle configurations will // work. For new lifecycle configurations, use the updated API. // @@ -7086,11 +7095,11 @@ func (c *S3) PutBucketLifecycleRequest(input *PutBucketLifecycleInput) (req *req // // Related Resources // -// * GetBucketLifecycle(Deprecated) +// * GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html)(Deprecated) // -// * GetBucketLifecycleConfiguration +// * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) // -// * +// * RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) // // * By default, a resource owner—in this case, a bucket owner, which is // the AWS account that created the bucket—can perform any of the operations. @@ -7189,7 +7198,7 @@ func (c *S3) PutBucketLifecycleConfigurationRequest(input *PutBucketLifecycleCon // Accordingly, this section describes the latest API. The previous version // of the API supported filtering based only on an object key name prefix, which // is supported for backward compatibility. For the related API description, -// see PutBucketLifecycle. +// see PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html). // // Rules // @@ -7240,9 +7249,9 @@ func (c *S3) PutBucketLifecycleConfigurationRequest(input *PutBucketLifecycleCon // // * Examples of Lifecycle Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html) // -// * GetBucketLifecycleConfiguration +// * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) // -// * DeleteBucketLifecycle +// * DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7355,18 +7364,19 @@ func (c *S3) PutBucketLoggingRequest(input *PutBucketLoggingInput) (req *request // For more information about server access logging, see Server Access Logging // (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html). // -// For more information about creating a bucket, see CreateBucket. For more -// information about returning the logging status of a bucket, see GetBucketLogging. +// For more information about creating a bucket, see CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). +// For more information about returning the logging status of a bucket, see +// GetBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html). // // The following operations are related to PutBucketLogging: // -// * PutObject +// * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) // -// * DeleteBucket +// * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * GetBucketLogging +// * GetBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7458,11 +7468,11 @@ func (c *S3) PutBucketMetricsConfigurationRequest(input *PutBucketMetricsConfigu // // The following operations are related to PutBucketMetricsConfiguration: // -// * DeleteBucketMetricsConfiguration +// * DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) // -// * PutBucketMetricsConfiguration +// * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) // -// * ListBucketMetricsConfigurations +// * ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) // // GetBucketLifecycle has the following special error: // @@ -7552,7 +7562,8 @@ func (c *S3) PutBucketNotificationRequest(input *PutBucketNotificationInput) (re // PutBucketNotification API operation for Amazon Simple Storage Service. // -// No longer used, see the PutBucketNotificationConfiguration operation. +// No longer used, see the PutBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html) +// operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7679,7 +7690,7 @@ func (c *S3) PutBucketNotificationConfigurationRequest(input *PutBucketNotificat // // The following operation is related to PutBucketNotificationConfiguration: // -// * GetBucketNotificationConfiguration +// * GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7777,9 +7788,9 @@ func (c *S3) PutBucketPolicyRequest(input *PutBucketPolicyInput) (req *request.R // // The following operations are related to PutBucketPolicy: // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * DeleteBucket +// * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7883,6 +7894,13 @@ func (c *S3) PutBucketReplicationRequest(input *PutBucketReplicationInput) (req // When you add the Filter element in the configuration, you must also add the // following elements: DeleteMarkerReplication, Status, and Priority. // +// The latest version of the replication configuration XML is V2. XML V2 replication +// configurations are those that contain the Filter element for rules, and rules +// that specify S3 Replication Time Control (S3 RTC). In XML V2 replication +// configurations, Amazon S3 doesn't replicate delete markers. Therefore, you +// must set the DeleteMarkerReplication element to Disabled. For backward compatibility, +// Amazon S3 continues to support the XML V1 replication configuration. +// // For information about enabling versioning on a bucket, see Using Versioning // (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html). // @@ -7901,13 +7919,14 @@ func (c *S3) PutBucketReplicationRequest(input *PutBucketReplicationInput) (req // replication configuration, see Replicating Objects Created with SSE Using // CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html). // -// For information on PutBucketReplication errors, see ReplicationErrorCodeList +// For information on PutBucketReplication errors, see List of replication-related +// error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) // // The following operations are related to PutBucketReplication: // -// * GetBucketReplication +// * GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) // -// * DeleteBucketReplication +// * DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7994,9 +8013,9 @@ func (c *S3) PutBucketRequestPaymentRequest(input *PutBucketRequestPaymentInput) // // The following operations are related to PutBucketRequestPayment: // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * GetBucketRequestPayment +// * GetBucketRequestPayment (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8114,9 +8133,9 @@ func (c *S3) PutBucketTaggingRequest(input *PutBucketTaggingInput) (req *request // // The following operations are related to PutBucketTagging: // -// * GetBucketTagging +// * GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) // -// * DeleteBucketTagging +// * DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8207,7 +8226,8 @@ func (c *S3) PutBucketVersioningRequest(input *PutBucketVersioningInput) (req *r // added to the bucket receive the version ID null. // // If the versioning state has never been set on a bucket, it has no versioning -// state; a GetBucketVersioning request does not return a versioning state value. +// state; a GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) +// request does not return a versioning state value. // // If the bucket owner enables MFA Delete in the bucket versioning configuration, // the bucket owner must include the x-amz-mfa request header and the Status @@ -8224,11 +8244,11 @@ func (c *S3) PutBucketVersioningRequest(input *PutBucketVersioningInput) (req *r // // Related Resources // -// * CreateBucket +// * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) // -// * DeleteBucket +// * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) // -// * GetBucketVersioning +// * GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8503,13 +8523,14 @@ func (c *S3) PutObjectRequest(input *PutObjectInput) (req *request.Request, outp // // For more information about versioning, see Adding Objects to Versioning Enabled // Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html). -// For information about returning the versioning state of a bucket, see GetBucketVersioning. +// For information about returning the versioning state of a bucket, see GetBucketVersioning +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html). // // Related Resources // -// * CopyObject +// * CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) // -// * DeleteObject +// * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8666,9 +8687,9 @@ func (c *S3) PutObjectAclRequest(input *PutObjectAclInput) (req *request.Request // // Related Resources // -// * CopyObject +// * CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9007,7 +9028,7 @@ func (c *S3) PutObjectTaggingRequest(input *PutObjectTaggingInput) (req *request // A tag is a key-value pair. You can associate tags with an object by sending // a PUT request against the tagging subresource that is associated with the // object. You can retrieve tags by sending a GET request. For more information, -// see GetObjectTagging. +// see GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html). // // For tagging-related restrictions related to characters and encodings, see // Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html). @@ -9039,7 +9060,7 @@ func (c *S3) PutObjectTaggingRequest(input *PutObjectTaggingInput) (req *request // // Related Resources // -// * GetObjectTagging +// * GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9135,11 +9156,11 @@ func (c *S3) PutPublicAccessBlockRequest(input *PutPublicAccessBlockInput) (req // // Related Resources // -// * GetPublicAccessBlock +// * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) // -// * DeletePublicAccessBlock +// * DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) // -// * GetBucketPolicyStatus +// * GetBucketPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) // // * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) // @@ -9251,7 +9272,8 @@ func (c *S3) RestoreObjectRequest(input *RestoreObjectInput) (req *request.Reque // (https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html) // in the Amazon Simple Storage Service Developer Guide. For more information // about the S3 structure in the request body, see the following: PutObject -// Managing Access with ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) Managing +// Access with ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) // in the Amazon Simple Storage Service Developer Guide Protecting Data Using // Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) // in the Amazon Simple Storage Service Developer Guide @@ -9367,7 +9389,8 @@ func (c *S3) RestoreObjectRequest(input *RestoreObjectInput) (req *request.Reque // specify in a restore request. For example, if you restore an object copy // for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes // the object in 3 days. For more information about lifecycle configuration, -// see PutBucketLifecycleConfiguration and Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) +// see PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) +// and Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) // in Amazon Simple Storage Service Developer Guide. // // Responses @@ -9394,9 +9417,9 @@ func (c *S3) RestoreObjectRequest(input *RestoreObjectInput) (req *request.Reque // // Related Resources // -// * PutBucketLifecycleConfiguration +// * PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) // -// * GetBucketNotificationConfiguration +// * GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) // // * SQL Reference for Amazon S3 Select and S3 Glacier Select (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html) // in the Amazon Simple Storage Service Developer Guide @@ -9528,8 +9551,8 @@ func (c *S3) SelectObjectContentRequest(input *SelectObjectContentInput) (req *r // * Server-side encryption - Amazon S3 Select supports querying objects // that are protected with server-side encryption. For objects that are encrypted // with customer-provided encryption keys (SSE-C), you must use HTTPS, and -// you must use the headers that are documented in the GetObject. For more -// information about SSE-C, see Server-Side Encryption (Using Customer-Provided +// you must use the headers that are documented in the GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html). +// For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided // Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html) // in the Amazon Simple Storage Service Developer Guide. For objects that // are encrypted with Amazon S3 managed encryption keys (SSE-S3) and customer @@ -9543,16 +9566,18 @@ func (c *S3) SelectObjectContentRequest(input *SelectObjectContentInput) (req *r // // Given the response size is unknown, Amazon S3 Select streams the response // as a series of messages and includes a Transfer-Encoding header with chunked -// as its value in the response. For more information, see RESTSelectObjectAppendix . +// as its value in the response. For more information, see Appendix: SelectObjectContent +// Response (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html) . // // GetObject Support // // The SelectObjectContent operation does not support the following GetObject -// functionality. For more information, see GetObject. +// functionality. For more information, see GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html). // // * Range: Although you can specify a scan range for an Amazon S3 Select -// request (see SelectObjectContentRequest$ScanRange in the request parameters), -// you cannot specify the range of bytes of an object to return. +// request (see SelectObjectContentRequest - ScanRange (https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange) +// in the request parameters), you cannot specify the range of bytes of an +// object to return. // // * GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot // specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. @@ -9561,15 +9586,16 @@ func (c *S3) SelectObjectContentRequest(input *SelectObjectContentInput) (req *r // // Special Errors // -// For a list of special errors for this operation, see SelectObjectContentErrorCodeList +// For a list of special errors for this operation, see List of SELECT Object +// Content Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList) // // Related Resources // -// * GetObject +// * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // -// * GetBucketLifecycleConfiguration +// * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) // -// * PutBucketLifecycleConfiguration +// * PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9792,12 +9818,13 @@ func (c *S3) UploadPartRequest(input *UploadPartInput) (req *request.Request, ou // In this operation, you provide part data in your request. However, you have // an option to specify your existing Amazon S3 object as a data source for // the part you are uploading. To upload a part from an existing object, you -// use the UploadPartCopy operation. +// use the UploadPartCopy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) +// operation. // -// You must initiate a multipart upload (see CreateMultipartUpload) before you -// can upload any part. In response to your initiate request, Amazon S3 returns -// an upload ID, a unique identifier, that you must include in your upload part -// request. +// You must initiate a multipart upload (see CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)) +// before you can upload any part. In response to your initiate request, Amazon +// S3 returns an upload ID, a unique identifier, that you must include in your +// upload part request. // // Part numbers can be any number from 1 to 10,000, inclusive. A part number // uniquely identifies a part and also defines its position within the object @@ -9831,25 +9858,25 @@ func (c *S3) UploadPartRequest(input *UploadPartInput) (req *request.Request, ou // key, or you can use the AWS managed encryption keys. If you choose to provide // your own encryption key, the request headers you provide in the request must // match the headers you used in the request to initiate the upload by using -// CreateMultipartUpload. For more information, go to Using Server-Side Encryption -// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) +// CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html). +// For more information, go to Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) // in the Amazon Simple Storage Service Developer Guide. // // Server-side encryption is supported by the S3 Multipart Upload actions. Unless // you are using a customer-provided encryption key, you don't need to specify // the encryption parameters in each UploadPart request. Instead, you only need // to specify the server-side encryption parameters in the initial Initiate -// Multipart request. For more information, see CreateMultipartUpload. +// Multipart request. For more information, see CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html). // // If you requested server-side encryption using a customer-provided encryption // key in your initiate multipart upload request, you must provide identical // encryption information in each part upload using the following headers. // -// * x-amz-server-side​-encryption​-customer-algorithm +// * x-amz-server-side-encryption-customer-algorithm // -// * x-amz-server-side​-encryption​-customer-key +// * x-amz-server-side-encryption-customer-key // -// * x-amz-server-side​-encryption​-customer-key-MD5 +// * x-amz-server-side-encryption-customer-key-MD5 // // Special Errors // @@ -9860,15 +9887,15 @@ func (c *S3) UploadPartRequest(input *UploadPartInput) (req *request.Request, ou // // Related Resources // -// * CreateMultipartUpload +// * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) // -// * CompleteMultipartUpload +// * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) // -// * AbortMultipartUpload +// * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) // -// * ListParts +// * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) // -// * ListMultipartUploads +// * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9952,7 +9979,8 @@ func (c *S3) UploadPartCopyRequest(input *UploadPartCopyInput) (req *request.Req // in the Amazon Simple Storage Service Developer Guide. // // Instead of using an existing object as part data, you might use the UploadPart -// operation and provide data in your request. +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) operation +// and provide data in your request. // // You must initiate a multipart upload before you can upload any part. In response // to your initiate request. Amazon S3 returns a unique identifier, the upload @@ -9973,8 +10001,8 @@ func (c *S3) UploadPartCopyRequest(input *UploadPartCopyInput) (req *request.Req // in the Amazon Simple Storage Service Developer Guide. // // * For information about using server-side encryption with customer-provided -// encryption keys with the UploadPartCopy operation, see CopyObject and -// UploadPart. +// encryption keys with the UploadPartCopy operation, see CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) +// and UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html). // // Note the following additional considerations about the request headers x-amz-copy-source-if-match, // x-amz-copy-source-if-none-match, x-amz-copy-source-if-unmodified-since, and @@ -10019,17 +10047,17 @@ func (c *S3) UploadPartCopyRequest(input *UploadPartCopyInput) (req *request.Req // // Related Resources // -// * CreateMultipartUpload +// * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) // -// * UploadPart +// * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) // -// * CompleteMultipartUpload +// * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) // -// * AbortMultipartUpload +// * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) // -// * ListParts +// * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) // -// * ListMultipartUploads +// * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11679,7 +11707,7 @@ type CopyObjectInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` @@ -12442,7 +12470,7 @@ type CreateMultipartUploadInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` @@ -14118,7 +14146,7 @@ type DeleteObjectTaggingInput struct { // Bucket is a required field Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"` - // Name of the tag. + // Name of the object key. // // Key is a required field Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"` @@ -17233,7 +17261,7 @@ type GetObjectInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` @@ -18748,7 +18776,7 @@ type HeadObjectInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` @@ -19009,7 +19037,8 @@ type HeadObjectOutput struct { // If the object is an archived object (an object whose storage class is GLACIER), // the response includes this header if either the archive restoration is in - // progress (see RestoreObject or an archive copy is already restored. + // progress (see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) + // or an archive copy is already restored. // // If an archive copy is already restored, the header value indicates when Amazon // S3 is scheduled to delete the object copy. For example: @@ -21474,7 +21503,7 @@ type ListObjectsOutput struct { // is true), you can use the key name in this field as marker in the subsequent // request to get next set of objects. Amazon S3 lists objects in alphabetical // order Note: This element is returned only if you have delimiter request parameter - // specified. If response does not include the NextMaker and it is truncated, + // specified. If response does not include the NextMarker and it is truncated, // you can use the value of the last Key in the response as the marker in the // subsequent request to get the next set of object keys. NextMarker *string `type:"string"` @@ -22954,8 +22983,22 @@ func (s *NotificationConfigurationFilter) SetKey(v *KeyFilter) *NotificationConf type Object struct { _ struct{} `type:"structure"` - // The entity tag is an MD5 hash of the object. ETag reflects only changes to - // the contents of an object, not its metadata. + // The entity tag is a hash of the object. The ETag reflects changes only to + // the contents of an object, not its metadata. The ETag may or may not be an + // MD5 digest of the object data. Whether or not it is depends on how the object + // was created and how it is encrypted as described below: + // + // * Objects created by the PUT Object, POST Object, or Copy operation, or + // through the AWS Management Console, and are encrypted by SSE-S3 or plaintext, + // have ETags that are an MD5 digest of their object data. + // + // * Objects created by the PUT Object, POST Object, or Copy operation, or + // through the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, + // have ETags that are not an MD5 digest of their object data. + // + // * If an object is created by either the Multipart Upload or Part Copy + // operation, the ETag is not an MD5 digest, regardless of the method of + // encryption. ETag *string `type:"string"` // The name that you assign to an object. You use the object key to retrieve @@ -25764,7 +25807,7 @@ type PutObjectInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` @@ -26329,7 +26372,8 @@ type PutObjectOutput struct { // Entity tag for the uploaded object. ETag *string `location:"header" locationName:"ETag" type:"string"` - // If the expiration is configured for the object (see PutBucketLifecycleConfiguration), + // If the expiration is configured for the object (see PutBucketLifecycleConfiguration + // (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)), // the response includes this header. It includes the expiry-date and rule-id // key-value pairs that provide information about object expiration. The value // of the rule-id is URL encoded. @@ -26602,7 +26646,7 @@ type PutObjectTaggingInput struct { // Bucket is a required field Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"` - // Name of the tag. + // Name of the object key. // // Key is a required field Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"` @@ -26895,10 +26939,10 @@ func (s *QueueConfiguration) SetQueueArn(v string) *QueueConfiguration { return s } -// This data type is deprecated. Use QueueConfiguration for the same purposes. -// This data type specifies the configuration for publishing messages to an -// Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified -// events. +// This data type is deprecated. Use QueueConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_QueueConfiguration.html) +// for the same purposes. This data type specifies the configuration for publishing +// messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon +// S3 detects specified events. type QueueConfigurationDeprecated struct { _ struct{} `type:"structure"` @@ -27907,7 +27951,10 @@ func (s *RestoreRequest) SetType(v string) *RestoreRequest { return s } -// Specifies the redirect behavior and when a redirect is applied. +// Specifies the redirect behavior and when a redirect is applied. For more +// information about routing rules, see Configuring advanced conditional redirects +// (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) +// in the Amazon Simple Storage Service Developer Guide. type RoutingRule struct { _ struct{} `type:"structure"` @@ -29123,7 +29170,7 @@ func (s *StorageClassAnalysisDataExport) SetOutputSchemaVersion(v string) *Stora type Tag struct { _ struct{} `type:"structure"` - // Name of the tag. + // Name of the object key. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` @@ -29354,6 +29401,7 @@ func (s *TopicConfiguration) SetTopicArn(v string) *TopicConfiguration { // 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. This data type is deprecated. Use TopicConfiguration +// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_TopicConfiguration.html) // instead. type TopicConfigurationDeprecated struct { _ struct{} `type:"structure"` @@ -29529,7 +29577,7 @@ type UploadPartCopyInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. This must be the same encryption key specified in the initiate multipart // upload request. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` @@ -29854,7 +29902,7 @@ type UploadPartInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. This must be the same encryption key specified in the initiate multipart // upload request. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` diff --git a/service/s3/examples_test.go b/service/s3/examples_test.go index b4a4831e4b4..59f8a81fe94 100644 --- a/service/s3/examples_test.go +++ b/service/s3/examples_test.go @@ -467,16 +467,16 @@ func ExampleS3_DeleteObject_shared01() { fmt.Println(result) } -// To remove tag set from an object version +// To remove tag set from an object // -// The following example removes tag set associated with the specified object version. -// The request specifies both the object key and object version. +// The following example removes tag set associated with the specified object. If the +// bucket is versioning enabled, the operation removes tag set from the latest object +// version. func ExampleS3_DeleteObjectTagging_shared00() { svc := s3.New(session.New()) input := &s3.DeleteObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.DeleteObjectTagging(input) @@ -497,16 +497,16 @@ func ExampleS3_DeleteObjectTagging_shared00() { fmt.Println(result) } -// To remove tag set from an object +// To remove tag set from an object version // -// The following example removes tag set associated with the specified object. If the -// bucket is versioning enabled, the operation removes tag set from the latest object -// version. +// The following example removes tag set associated with the specified object version. +// The request specifies both the object key and object version. func ExampleS3_DeleteObjectTagging_shared01() { svc := s3.New(session.New()) input := &s3.DeleteObjectTaggingInput{ - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + VersionId: aws.String("ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"), } result, err := svc.DeleteObjectTagging(input) @@ -1197,17 +1197,13 @@ func ExampleS3_ListBuckets_shared00() { fmt.Println(result) } -// List next set of multipart uploads when previous result is truncated +// To list in-progress multipart uploads on a bucket // -// The following example specifies the upload-id-marker and key-marker from previous -// truncated response to retrieve next setup of multipart uploads. +// The following example lists in-progress multipart uploads on a specific bucket. func ExampleS3_ListMultipartUploads_shared00() { svc := s3.New(session.New()) input := &s3.ListMultipartUploadsInput{ - Bucket: aws.String("examplebucket"), - KeyMarker: aws.String("nextkeyfrompreviousresponse"), - MaxUploads: aws.Int64(2), - UploadIdMarker: aws.String("valuefrompreviousresponse"), + Bucket: aws.String("examplebucket"), } result, err := svc.ListMultipartUploads(input) @@ -1228,13 +1224,17 @@ func ExampleS3_ListMultipartUploads_shared00() { fmt.Println(result) } -// To list in-progress multipart uploads on a bucket +// List next set of multipart uploads when previous result is truncated // -// The following example lists in-progress multipart uploads on a specific bucket. +// The following example specifies the upload-id-marker and key-marker from previous +// truncated response to retrieve next setup of multipart uploads. func ExampleS3_ListMultipartUploads_shared01() { svc := s3.New(session.New()) input := &s3.ListMultipartUploadsInput{ - Bucket: aws.String("examplebucket"), + Bucket: aws.String("examplebucket"), + KeyMarker: aws.String("nextkeyfrompreviousresponse"), + MaxUploads: aws.Int64(2), + UploadIdMarker: aws.String("valuefrompreviousresponse"), } result, err := svc.ListMultipartUploads(input) @@ -1804,19 +1804,20 @@ func ExampleS3_PutBucketWebsite_shared00() { fmt.Println(result) } -// To upload an object and specify server-side encryption and object tags +// To upload object and specify user-defined metadata // -// The following example uploads and object. The request specifies the optional server-side -// encryption option. The request also specifies optional object tags. If the bucket -// is versioning enabled, S3 returns version ID in response. +// The following example creates an object. The request also specifies optional metadata. +// If the bucket is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared00() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - ServerSideEncryption: aws.String("AES256"), - Tagging: aws.String("key1=value1&key2=value2"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + Metadata: map[string]*string{ + "metadata1": aws.String("value1"), + "metadata2": aws.String("value2"), + }, } result, err := svc.PutObject(input) @@ -1837,16 +1838,18 @@ func ExampleS3_PutObject_shared00() { fmt.Println(result) } -// To create an object. +// To upload an object and specify canned ACL. // -// The following example creates an object. If the bucket is versioning enabled, S3 -// returns version ID in response. +// The following example uploads and object. The request specifies optional canned ACL +// (access control list) to all READ access to authenticated users. If the bucket is +// versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared01() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ + ACL: aws.String("authenticated-read"), Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), Bucket: aws.String("examplebucket"), - Key: aws.String("objectkey"), + Key: aws.String("exampleobject"), } result, err := svc.PutObject(input) @@ -1867,17 +1870,16 @@ func ExampleS3_PutObject_shared01() { fmt.Println(result) } -// To upload an object and specify optional tags +// To create an object. // -// The following example uploads an object. The request specifies optional object tags. -// The bucket is versioned, therefore S3 returns version ID of the newly created object. +// The following example creates an object. If the bucket is versioning enabled, S3 +// returns version ID in response. func ExampleS3_PutObject_shared02() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - Tagging: aws.String("key1=value1&key2=value2"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("objectkey"), } result, err := svc.PutObject(input) @@ -1898,18 +1900,17 @@ func ExampleS3_PutObject_shared02() { fmt.Println(result) } -// To upload an object (specify optional headers) +// To upload an object // -// The following example uploads an object. The request specifies optional request headers -// to directs S3 to use specific storage class and use server-side encryption. +// The following example uploads an object to a versioning-enabled bucket. The source +// file is specified using Windows file syntax. S3 returns VersionId of the newly created +// object. func ExampleS3_PutObject_shared03() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), - ServerSideEncryption: aws.String("AES256"), - StorageClass: aws.String("STANDARD_IA"), + Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), } result, err := svc.PutObject(input) @@ -1930,20 +1931,17 @@ func ExampleS3_PutObject_shared03() { fmt.Println(result) } -// To upload object and specify user-defined metadata +// To upload an object and specify optional tags // -// The following example creates an object. The request also specifies optional metadata. -// If the bucket is versioning enabled, S3 returns version ID in response. +// The following example uploads an object. The request specifies optional object tags. +// The bucket is versioned, therefore S3 returns version ID of the newly created object. func ExampleS3_PutObject_shared04() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), - Metadata: map[string]*string{ - "metadata1": aws.String("value1"), - "metadata2": aws.String("value2"), - }, + Body: aws.ReadSeekCloser(strings.NewReader("c:\\HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input) @@ -1964,18 +1962,19 @@ func ExampleS3_PutObject_shared04() { fmt.Println(result) } -// To upload an object and specify canned ACL. +// To upload an object and specify server-side encryption and object tags // -// The following example uploads and object. The request specifies optional canned ACL -// (access control list) to all READ access to authenticated users. If the bucket is -// versioning enabled, S3 returns version ID in response. +// The following example uploads and object. The request specifies the optional server-side +// encryption option. The request also specifies optional object tags. If the bucket +// is versioning enabled, S3 returns version ID in response. func ExampleS3_PutObject_shared05() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - ACL: aws.String("authenticated-read"), - Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), - Bucket: aws.String("examplebucket"), - Key: aws.String("exampleobject"), + Body: aws.ReadSeekCloser(strings.NewReader("filetoupload")), + Bucket: aws.String("examplebucket"), + Key: aws.String("exampleobject"), + ServerSideEncryption: aws.String("AES256"), + Tagging: aws.String("key1=value1&key2=value2"), } result, err := svc.PutObject(input) @@ -1996,17 +1995,18 @@ func ExampleS3_PutObject_shared05() { fmt.Println(result) } -// To upload an object +// To upload an object (specify optional headers) // -// The following example uploads an object to a versioning-enabled bucket. The source -// file is specified using Windows file syntax. S3 returns VersionId of the newly created -// object. +// The following example uploads an object. The request specifies optional request headers +// to directs S3 to use specific storage class and use server-side encryption. func ExampleS3_PutObject_shared06() { svc := s3.New(session.New()) input := &s3.PutObjectInput{ - Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), - Bucket: aws.String("examplebucket"), - Key: aws.String("HappyFace.jpg"), + Body: aws.ReadSeekCloser(strings.NewReader("HappyFace.jpg")), + Bucket: aws.String("examplebucket"), + Key: aws.String("HappyFace.jpg"), + ServerSideEncryption: aws.String("AES256"), + StorageClass: aws.String("STANDARD_IA"), } result, err := svc.PutObject(input) @@ -2171,18 +2171,19 @@ func ExampleS3_UploadPart_shared00() { fmt.Println(result) } -// To upload a part by copying data from an existing object as data source +// To upload a part by copying byte range from an existing object as data source // -// The following example uploads a part of a multipart upload by copying data from an -// existing object as data source. +// The following example uploads a part of a multipart upload by copying a specified +// byte range from an existing object as data source. func ExampleS3_UploadPartCopy_shared00() { svc := s3.New(session.New()) input := &s3.UploadPartCopyInput{ - Bucket: aws.String("examplebucket"), - CopySource: aws.String("/bucketname/sourceobjectkey"), - Key: aws.String("examplelargeobject"), - PartNumber: aws.Int64(1), - UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), + Bucket: aws.String("examplebucket"), + CopySource: aws.String("/bucketname/sourceobjectkey"), + CopySourceRange: aws.String("bytes=1-100000"), + Key: aws.String("examplelargeobject"), + PartNumber: aws.Int64(2), + UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), } result, err := svc.UploadPartCopy(input) @@ -2203,19 +2204,18 @@ func ExampleS3_UploadPartCopy_shared00() { fmt.Println(result) } -// To upload a part by copying byte range from an existing object as data source +// To upload a part by copying data from an existing object as data source // -// The following example uploads a part of a multipart upload by copying a specified -// byte range from an existing object as data source. +// The following example uploads a part of a multipart upload by copying data from an +// existing object as data source. func ExampleS3_UploadPartCopy_shared01() { svc := s3.New(session.New()) input := &s3.UploadPartCopyInput{ - Bucket: aws.String("examplebucket"), - CopySource: aws.String("/bucketname/sourceobjectkey"), - CopySourceRange: aws.String("bytes=1-100000"), - Key: aws.String("examplelargeobject"), - PartNumber: aws.Int64(2), - UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), + Bucket: aws.String("examplebucket"), + CopySource: aws.String("/bucketname/sourceobjectkey"), + Key: aws.String("examplelargeobject"), + PartNumber: aws.Int64(1), + UploadId: aws.String("exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"), } result, err := svc.UploadPartCopy(input) diff --git a/service/s3/s3manager/upload_input.go b/service/s3/s3manager/upload_input.go index c8810c11bbf..e1e609d0ee8 100644 --- a/service/s3/s3manager/upload_input.go +++ b/service/s3/s3manager/upload_input.go @@ -111,7 +111,7 @@ type UploadInput struct { // Specifies the customer-provided encryption key for Amazon S3 to use in encrypting // data. This value is used to store the object and then it is discarded; Amazon // S3 does not store the encryption key. The key must be appropriate for use - // with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm + // with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm // header. SSECustomerKey *string `marshal-as:"blob" location:"header" locationName:"x-amz-server-side-encryption-customer-key" type:"string" sensitive:"true"` diff --git a/service/sms/api.go b/service/sms/api.go index 715d286b10f..7ab0599622e 100644 --- a/service/sms/api.go +++ b/service/sms/api.go @@ -257,9 +257,9 @@ func (c *SMS) DeleteAppRequest(input *DeleteAppInput) (req *request.Request, out // DeleteApp API operation for AWS Server Migration Service. // -// Deletes an existing application. Optionally deletes the launched stack associated -// with the application and all AWS SMS replication jobs for servers in the -// application. +// Deletes the specified application. Optionally deletes the launched stack +// associated with the application and all AWS SMS replication jobs for servers +// in the application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -352,7 +352,7 @@ func (c *SMS) DeleteAppLaunchConfigurationRequest(input *DeleteAppLaunchConfigur // DeleteAppLaunchConfiguration API operation for AWS Server Migration Service. // -// Deletes existing launch configuration for an application. +// Deletes the launch configuration for the specified application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -445,7 +445,7 @@ func (c *SMS) DeleteAppReplicationConfigurationRequest(input *DeleteAppReplicati // DeleteAppReplicationConfiguration API operation for AWS Server Migration Service. // -// Deletes existing replication configuration for an application. +// Deletes the replication configuration for the specified application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -493,6 +493,99 @@ func (c *SMS) DeleteAppReplicationConfigurationWithContext(ctx aws.Context, inpu return out, req.Send() } +const opDeleteAppValidationConfiguration = "DeleteAppValidationConfiguration" + +// DeleteAppValidationConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAppValidationConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteAppValidationConfiguration for more information on using the DeleteAppValidationConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteAppValidationConfigurationRequest method. +// req, resp := client.DeleteAppValidationConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppValidationConfiguration +func (c *SMS) DeleteAppValidationConfigurationRequest(input *DeleteAppValidationConfigurationInput) (req *request.Request, output *DeleteAppValidationConfigurationOutput) { + op := &request.Operation{ + Name: opDeleteAppValidationConfiguration, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteAppValidationConfigurationInput{} + } + + output = &DeleteAppValidationConfigurationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteAppValidationConfiguration API operation for AWS Server Migration Service. +// +// Deletes the validation configuration for the specified application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Server Migration Service's +// API operation DeleteAppValidationConfiguration for usage and error information. +// +// Returned Error Types: +// * UnauthorizedOperationException +// You lack permissions needed to perform this operation. Check your IAM policies, +// and ensure that you are using the correct access keys. +// +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * InternalError +// An internal error occurred. +// +// * OperationNotPermittedException +// This operation is not allowed. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppValidationConfiguration +func (c *SMS) DeleteAppValidationConfiguration(input *DeleteAppValidationConfigurationInput) (*DeleteAppValidationConfigurationOutput, error) { + req, out := c.DeleteAppValidationConfigurationRequest(input) + return out, req.Send() +} + +// DeleteAppValidationConfigurationWithContext is the same as DeleteAppValidationConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAppValidationConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SMS) DeleteAppValidationConfigurationWithContext(ctx aws.Context, input *DeleteAppValidationConfigurationInput, opts ...request.Option) (*DeleteAppValidationConfigurationOutput, error) { + req, out := c.DeleteAppValidationConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteReplicationJob = "DeleteReplicationJob" // DeleteReplicationJobRequest generates a "aws/request.Request" representing the @@ -910,7 +1003,7 @@ func (c *SMS) GenerateTemplateRequest(input *GenerateTemplateInput) (req *reques // GenerateTemplate API operation for AWS Server Migration Service. // -// Generates an Amazon CloudFormation template based on the current launch configuration +// Generates an AWS CloudFormation template based on the current launch configuration // and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1003,7 +1096,7 @@ func (c *SMS) GetAppRequest(input *GetAppInput) (req *request.Request, output *G // GetApp API operation for AWS Server Migration Service. // -// Retrieve information about an application. +// Retrieve information about the specified application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1095,7 +1188,8 @@ func (c *SMS) GetAppLaunchConfigurationRequest(input *GetAppLaunchConfigurationI // GetAppLaunchConfiguration API operation for AWS Server Migration Service. // -// Retrieves the application launch configuration associated with an application. +// Retrieves the application launch configuration associated with the specified +// application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1187,7 +1281,8 @@ func (c *SMS) GetAppReplicationConfigurationRequest(input *GetAppReplicationConf // GetAppReplicationConfiguration API operation for AWS Server Migration Service. // -// Retrieves an application replication configuration associatd with an application. +// Retrieves the application replication configuration associated with the specified +// application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1235,6 +1330,190 @@ func (c *SMS) GetAppReplicationConfigurationWithContext(ctx aws.Context, input * return out, req.Send() } +const opGetAppValidationConfiguration = "GetAppValidationConfiguration" + +// GetAppValidationConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the GetAppValidationConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAppValidationConfiguration for more information on using the GetAppValidationConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetAppValidationConfigurationRequest method. +// req, resp := client.GetAppValidationConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppValidationConfiguration +func (c *SMS) GetAppValidationConfigurationRequest(input *GetAppValidationConfigurationInput) (req *request.Request, output *GetAppValidationConfigurationOutput) { + op := &request.Operation{ + Name: opGetAppValidationConfiguration, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetAppValidationConfigurationInput{} + } + + output = &GetAppValidationConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAppValidationConfiguration API operation for AWS Server Migration Service. +// +// Retrieves information about a configuration for validating an application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Server Migration Service's +// API operation GetAppValidationConfiguration for usage and error information. +// +// Returned Error Types: +// * UnauthorizedOperationException +// You lack permissions needed to perform this operation. Check your IAM policies, +// and ensure that you are using the correct access keys. +// +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * InternalError +// An internal error occurred. +// +// * OperationNotPermittedException +// This operation is not allowed. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppValidationConfiguration +func (c *SMS) GetAppValidationConfiguration(input *GetAppValidationConfigurationInput) (*GetAppValidationConfigurationOutput, error) { + req, out := c.GetAppValidationConfigurationRequest(input) + return out, req.Send() +} + +// GetAppValidationConfigurationWithContext is the same as GetAppValidationConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See GetAppValidationConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SMS) GetAppValidationConfigurationWithContext(ctx aws.Context, input *GetAppValidationConfigurationInput, opts ...request.Option) (*GetAppValidationConfigurationOutput, error) { + req, out := c.GetAppValidationConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetAppValidationOutput = "GetAppValidationOutput" + +// GetAppValidationOutputRequest generates a "aws/request.Request" representing the +// client's request for the GetAppValidationOutput operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAppValidationOutput for more information on using the GetAppValidationOutput +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetAppValidationOutputRequest method. +// req, resp := client.GetAppValidationOutputRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppValidationOutput +func (c *SMS) GetAppValidationOutputRequest(input *GetAppValidationOutputInput) (req *request.Request, output *GetAppValidationOutputOutput) { + op := &request.Operation{ + Name: opGetAppValidationOutput, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetAppValidationOutputInput{} + } + + output = &GetAppValidationOutputOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAppValidationOutput API operation for AWS Server Migration Service. +// +// Retrieves output from validating an application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Server Migration Service's +// API operation GetAppValidationOutput for usage and error information. +// +// Returned Error Types: +// * UnauthorizedOperationException +// You lack permissions needed to perform this operation. Check your IAM policies, +// and ensure that you are using the correct access keys. +// +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * InternalError +// An internal error occurred. +// +// * OperationNotPermittedException +// This operation is not allowed. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppValidationOutput +func (c *SMS) GetAppValidationOutput(input *GetAppValidationOutputInput) (*GetAppValidationOutputOutput, error) { + req, out := c.GetAppValidationOutputRequest(input) + return out, req.Send() +} + +// GetAppValidationOutputWithContext is the same as GetAppValidationOutput with the addition of +// the ability to pass a context and additional request options. +// +// See GetAppValidationOutput for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SMS) GetAppValidationOutputWithContext(ctx aws.Context, input *GetAppValidationOutputInput, opts ...request.Option) (*GetAppValidationOutputOutput, error) { + req, out := c.GetAppValidationOutputRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetConnectors = "GetConnectors" // GetConnectorsRequest generates a "aws/request.Request" representing the @@ -1727,6 +2006,15 @@ func (c *SMS) GetServersRequest(input *GetServersInput) (req *request.Request, o // You lack permissions needed to perform this operation. Check your IAM policies, // and ensure that you are using the correct access keys. // +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * InternalError +// An internal error occurred. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetServers func (c *SMS) GetServers(input *GetServersInput) (*GetServersOutput, error) { req, out := c.GetServersRequest(input) @@ -1801,84 +2089,177 @@ func (c *SMS) GetServersPagesWithContext(ctx aws.Context, input *GetServersInput return p.Err() } -const opImportServerCatalog = "ImportServerCatalog" +const opImportAppCatalog = "ImportAppCatalog" -// ImportServerCatalogRequest generates a "aws/request.Request" representing the -// client's request for the ImportServerCatalog operation. The "output" return +// ImportAppCatalogRequest generates a "aws/request.Request" representing the +// client's request for the ImportAppCatalog operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ImportServerCatalog for more information on using the ImportServerCatalog +// See ImportAppCatalog for more information on using the ImportAppCatalog // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ImportServerCatalogRequest method. -// req, resp := client.ImportServerCatalogRequest(params) +// // Example sending a request using the ImportAppCatalogRequest method. +// req, resp := client.ImportAppCatalogRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalog -func (c *SMS) ImportServerCatalogRequest(input *ImportServerCatalogInput) (req *request.Request, output *ImportServerCatalogOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportAppCatalog +func (c *SMS) ImportAppCatalogRequest(input *ImportAppCatalogInput) (req *request.Request, output *ImportAppCatalogOutput) { op := &request.Operation{ - Name: opImportServerCatalog, + Name: opImportAppCatalog, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &ImportServerCatalogInput{} + input = &ImportAppCatalogInput{} } - output = &ImportServerCatalogOutput{} + output = &ImportAppCatalogOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ImportServerCatalog API operation for AWS Server Migration Service. -// -// Gathers a complete list of on-premises servers. Connectors must be installed -// and monitoring all servers that you want to import. +// ImportAppCatalog API operation for AWS Server Migration Service. // -// This call returns immediately, but might take additional time to retrieve -// all the servers. +// Allows application import from AWS Migration Hub. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Server Migration Service's -// API operation ImportServerCatalog for usage and error information. +// API operation ImportAppCatalog for usage and error information. // // Returned Error Types: // * UnauthorizedOperationException // You lack permissions needed to perform this operation. Check your IAM policies, // and ensure that you are using the correct access keys. // -// * OperationNotPermittedException -// This operation is not allowed. -// // * InvalidParameterException // A specified parameter is not valid. // // * MissingRequiredParameterException // A required parameter is missing. // -// * NoConnectorsAvailableException -// There are no connectors available. +// * InternalError +// An internal error occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalog -func (c *SMS) ImportServerCatalog(input *ImportServerCatalogInput) (*ImportServerCatalogOutput, error) { - req, out := c.ImportServerCatalogRequest(input) +// * OperationNotPermittedException +// This operation is not allowed. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportAppCatalog +func (c *SMS) ImportAppCatalog(input *ImportAppCatalogInput) (*ImportAppCatalogOutput, error) { + req, out := c.ImportAppCatalogRequest(input) + return out, req.Send() +} + +// ImportAppCatalogWithContext is the same as ImportAppCatalog with the addition of +// the ability to pass a context and additional request options. +// +// See ImportAppCatalog for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SMS) ImportAppCatalogWithContext(ctx aws.Context, input *ImportAppCatalogInput, opts ...request.Option) (*ImportAppCatalogOutput, error) { + req, out := c.ImportAppCatalogRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opImportServerCatalog = "ImportServerCatalog" + +// ImportServerCatalogRequest generates a "aws/request.Request" representing the +// client's request for the ImportServerCatalog operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ImportServerCatalog for more information on using the ImportServerCatalog +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ImportServerCatalogRequest method. +// req, resp := client.ImportServerCatalogRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalog +func (c *SMS) ImportServerCatalogRequest(input *ImportServerCatalogInput) (req *request.Request, output *ImportServerCatalogOutput) { + op := &request.Operation{ + Name: opImportServerCatalog, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ImportServerCatalogInput{} + } + + output = &ImportServerCatalogOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// ImportServerCatalog API operation for AWS Server Migration Service. +// +// Gathers a complete list of on-premises servers. Connectors must be installed +// and monitoring all servers to import. +// +// This call returns immediately, but might take additional time to retrieve +// all the servers. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Server Migration Service's +// API operation ImportServerCatalog for usage and error information. +// +// Returned Error Types: +// * UnauthorizedOperationException +// You lack permissions needed to perform this operation. Check your IAM policies, +// and ensure that you are using the correct access keys. +// +// * OperationNotPermittedException +// This operation is not allowed. +// +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * NoConnectorsAvailableException +// There are no connectors available. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalog +func (c *SMS) ImportServerCatalog(input *ImportServerCatalogInput) (*ImportServerCatalogOutput, error) { + req, out := c.ImportServerCatalogRequest(input) return out, req.Send() } @@ -1943,7 +2324,7 @@ func (c *SMS) LaunchAppRequest(input *LaunchAppInput) (req *request.Request, out // LaunchApp API operation for AWS Server Migration Service. // -// Launches an application stack. +// Launches the specified application as a stack in AWS CloudFormation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2035,7 +2416,7 @@ func (c *SMS) ListAppsRequest(input *ListAppsInput) (req *request.Request, outpu // ListApps API operation for AWS Server Migration Service. // -// Returns a list of summaries for all applications. +// Retrieves summaries for all applications. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2083,6 +2464,99 @@ func (c *SMS) ListAppsWithContext(ctx aws.Context, input *ListAppsInput, opts .. return out, req.Send() } +const opNotifyAppValidationOutput = "NotifyAppValidationOutput" + +// NotifyAppValidationOutputRequest generates a "aws/request.Request" representing the +// client's request for the NotifyAppValidationOutput operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See NotifyAppValidationOutput for more information on using the NotifyAppValidationOutput +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the NotifyAppValidationOutputRequest method. +// req, resp := client.NotifyAppValidationOutputRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/NotifyAppValidationOutput +func (c *SMS) NotifyAppValidationOutputRequest(input *NotifyAppValidationOutputInput) (req *request.Request, output *NotifyAppValidationOutputOutput) { + op := &request.Operation{ + Name: opNotifyAppValidationOutput, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &NotifyAppValidationOutputInput{} + } + + output = &NotifyAppValidationOutputOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// NotifyAppValidationOutput API operation for AWS Server Migration Service. +// +// Provides information to AWS SMS about whether application validation is successful. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Server Migration Service's +// API operation NotifyAppValidationOutput for usage and error information. +// +// Returned Error Types: +// * UnauthorizedOperationException +// You lack permissions needed to perform this operation. Check your IAM policies, +// and ensure that you are using the correct access keys. +// +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * InternalError +// An internal error occurred. +// +// * OperationNotPermittedException +// This operation is not allowed. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/NotifyAppValidationOutput +func (c *SMS) NotifyAppValidationOutput(input *NotifyAppValidationOutputInput) (*NotifyAppValidationOutputOutput, error) { + req, out := c.NotifyAppValidationOutputRequest(input) + return out, req.Send() +} + +// NotifyAppValidationOutputWithContext is the same as NotifyAppValidationOutput with the addition of +// the ability to pass a context and additional request options. +// +// See NotifyAppValidationOutput for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SMS) NotifyAppValidationOutputWithContext(ctx aws.Context, input *NotifyAppValidationOutputInput, opts ...request.Option) (*NotifyAppValidationOutputOutput, error) { + req, out := c.NotifyAppValidationOutputRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opPutAppLaunchConfiguration = "PutAppLaunchConfiguration" // PutAppLaunchConfigurationRequest generates a "aws/request.Request" representing the @@ -2128,7 +2602,7 @@ func (c *SMS) PutAppLaunchConfigurationRequest(input *PutAppLaunchConfigurationI // PutAppLaunchConfiguration API operation for AWS Server Migration Service. // -// Creates a launch configuration for an application. +// Creates or updates the launch configuration for the specified application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2221,7 +2695,7 @@ func (c *SMS) PutAppReplicationConfigurationRequest(input *PutAppReplicationConf // PutAppReplicationConfiguration API operation for AWS Server Migration Service. // -// Creates or updates a replication configuration for an application. +// Creates or updates the replication configuration for the specified application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2269,6 +2743,99 @@ func (c *SMS) PutAppReplicationConfigurationWithContext(ctx aws.Context, input * return out, req.Send() } +const opPutAppValidationConfiguration = "PutAppValidationConfiguration" + +// PutAppValidationConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the PutAppValidationConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See PutAppValidationConfiguration for more information on using the PutAppValidationConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the PutAppValidationConfigurationRequest method. +// req, resp := client.PutAppValidationConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppValidationConfiguration +func (c *SMS) PutAppValidationConfigurationRequest(input *PutAppValidationConfigurationInput) (req *request.Request, output *PutAppValidationConfigurationOutput) { + op := &request.Operation{ + Name: opPutAppValidationConfiguration, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &PutAppValidationConfigurationInput{} + } + + output = &PutAppValidationConfigurationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// PutAppValidationConfiguration API operation for AWS Server Migration Service. +// +// Creates or updates a validation configuration for the specified application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Server Migration Service's +// API operation PutAppValidationConfiguration for usage and error information. +// +// Returned Error Types: +// * UnauthorizedOperationException +// You lack permissions needed to perform this operation. Check your IAM policies, +// and ensure that you are using the correct access keys. +// +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * InternalError +// An internal error occurred. +// +// * OperationNotPermittedException +// This operation is not allowed. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppValidationConfiguration +func (c *SMS) PutAppValidationConfiguration(input *PutAppValidationConfigurationInput) (*PutAppValidationConfigurationOutput, error) { + req, out := c.PutAppValidationConfigurationRequest(input) + return out, req.Send() +} + +// PutAppValidationConfigurationWithContext is the same as PutAppValidationConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See PutAppValidationConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SMS) PutAppValidationConfigurationWithContext(ctx aws.Context, input *PutAppValidationConfigurationInput, opts ...request.Option) (*PutAppValidationConfigurationOutput, error) { + req, out := c.PutAppValidationConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStartAppReplication = "StartAppReplication" // StartAppReplicationRequest generates a "aws/request.Request" representing the @@ -2314,7 +2881,8 @@ func (c *SMS) StartAppReplicationRequest(input *StartAppReplicationInput) (req * // StartAppReplication API operation for AWS Server Migration Service. // -// Starts replicating an application. +// Starts replicating the specified application by creating replication jobs +// for each server in the application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2362,6 +2930,99 @@ func (c *SMS) StartAppReplicationWithContext(ctx aws.Context, input *StartAppRep return out, req.Send() } +const opStartOnDemandAppReplication = "StartOnDemandAppReplication" + +// StartOnDemandAppReplicationRequest generates a "aws/request.Request" representing the +// client's request for the StartOnDemandAppReplication operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartOnDemandAppReplication for more information on using the StartOnDemandAppReplication +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartOnDemandAppReplicationRequest method. +// req, resp := client.StartOnDemandAppReplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandAppReplication +func (c *SMS) StartOnDemandAppReplicationRequest(input *StartOnDemandAppReplicationInput) (req *request.Request, output *StartOnDemandAppReplicationOutput) { + op := &request.Operation{ + Name: opStartOnDemandAppReplication, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartOnDemandAppReplicationInput{} + } + + output = &StartOnDemandAppReplicationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// StartOnDemandAppReplication API operation for AWS Server Migration Service. +// +// Starts an on-demand replication run for the specified application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Server Migration Service's +// API operation StartOnDemandAppReplication for usage and error information. +// +// Returned Error Types: +// * UnauthorizedOperationException +// You lack permissions needed to perform this operation. Check your IAM policies, +// and ensure that you are using the correct access keys. +// +// * InvalidParameterException +// A specified parameter is not valid. +// +// * MissingRequiredParameterException +// A required parameter is missing. +// +// * InternalError +// An internal error occurred. +// +// * OperationNotPermittedException +// This operation is not allowed. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandAppReplication +func (c *SMS) StartOnDemandAppReplication(input *StartOnDemandAppReplicationInput) (*StartOnDemandAppReplicationOutput, error) { + req, out := c.StartOnDemandAppReplicationRequest(input) + return out, req.Send() +} + +// StartOnDemandAppReplicationWithContext is the same as StartOnDemandAppReplication with the addition of +// the ability to pass a context and additional request options. +// +// See StartOnDemandAppReplication for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *SMS) StartOnDemandAppReplicationWithContext(ctx aws.Context, input *StartOnDemandAppReplicationInput, opts ...request.Option) (*StartOnDemandAppReplicationOutput, error) { + req, out := c.StartOnDemandAppReplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStartOnDemandReplicationRun = "StartOnDemandReplicationRun" // StartOnDemandReplicationRunRequest generates a "aws/request.Request" representing the @@ -2410,8 +3071,8 @@ func (c *SMS) StartOnDemandReplicationRunRequest(input *StartOnDemandReplication // replication run starts immediately. This replication run is in addition to // the ones already scheduled. // -// There is a limit on the number of on-demand replications runs you can request -// in a 24-hour period. +// There is a limit on the number of on-demand replications runs that you can +// request in a 24-hour period. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2438,6 +3099,10 @@ func (c *SMS) StartOnDemandReplicationRunRequest(input *StartOnDemandReplication // You have exceeded the number of on-demand replication runs you can request // in a 24-hour period. // +// * DryRunOperationException +// The user has the required permissions, so the request would have succeeded, +// but a dry run was performed. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandReplicationRun func (c *SMS) StartOnDemandReplicationRun(input *StartOnDemandReplicationRunInput) (*StartOnDemandReplicationRunOutput, error) { req, out := c.StartOnDemandReplicationRunRequest(input) @@ -2505,7 +3170,8 @@ func (c *SMS) StopAppReplicationRequest(input *StopAppReplicationInput) (req *re // StopAppReplication API operation for AWS Server Migration Service. // -// Stops replicating an application. +// Stops replicating the specified application by deleting the replication job +// for each server in the application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2598,7 +3264,7 @@ func (c *SMS) TerminateAppRequest(input *TerminateAppInput) (req *request.Reques // TerminateApp API operation for AWS Server Migration Service. // -// Terminates the stack for an application. +// Terminates the stack for the specified application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2690,7 +3356,7 @@ func (c *SMS) UpdateAppRequest(input *UpdateAppInput) (req *request.Request, out // UpdateApp API operation for AWS Server Migration Service. // -// Updates an application. +// Updates the specified application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2844,40 +3510,49 @@ func (c *SMS) UpdateReplicationJobWithContext(ctx aws.Context, input *UpdateRepl type AppSummary struct { _ struct{} `type:"structure"` - // Unique ID of the application. + // The unique ID of the application. AppId *string `locationName:"appId" type:"string"` - // Time of creation of this application. + // The creation time of the application. CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` - // Description of the application. + // The description of the application. Description *string `locationName:"description" type:"string"` - // Timestamp of the application's creation. + // The ID of the application. + ImportedAppId *string `locationName:"importedAppId" type:"string"` + + // The last modified time of the application. LastModified *time.Time `locationName:"lastModified" type:"timestamp"` - // Timestamp of the application's most recent successful replication. + // The timestamp of the application's most recent successful replication. LatestReplicationTime *time.Time `locationName:"latestReplicationTime" type:"timestamp"` + // Status of the launch configuration. + LaunchConfigurationStatus *string `locationName:"launchConfigurationStatus" type:"string" enum:"AppLaunchConfigurationStatus"` + // Details about the latest launch of the application. LaunchDetails *LaunchDetails `locationName:"launchDetails" type:"structure"` - // Launch status of the application. + // The launch status of the application. LaunchStatus *string `locationName:"launchStatus" type:"string" enum:"AppLaunchStatus"` // A message related to the launch status of the application. LaunchStatusMessage *string `locationName:"launchStatusMessage" type:"string"` - // Name of the application. + // The name of the application. Name *string `locationName:"name" type:"string"` - // Replication status of the application. + // Status of the replication configuration. + ReplicationConfigurationStatus *string `locationName:"replicationConfigurationStatus" type:"string" enum:"AppReplicationConfigurationStatus"` + + // The replication status of the application. ReplicationStatus *string `locationName:"replicationStatus" type:"string" enum:"AppReplicationStatus"` // A message related to the replication status of the application. ReplicationStatusMessage *string `locationName:"replicationStatusMessage" type:"string"` - // Name of the service role in the customer's account used by AWS SMS. + // The name of the service role in the customer's account used by AWS SMS. RoleName *string `locationName:"roleName" type:"string"` // Status of the application. @@ -2886,10 +3561,10 @@ type AppSummary struct { // A message related to the status of the application StatusMessage *string `locationName:"statusMessage" type:"string"` - // Number of server groups present in the application. + // The number of server groups present in the application. TotalServerGroups *int64 `locationName:"totalServerGroups" type:"integer"` - // Number of servers present in the application. + // The number of servers present in the application. TotalServers *int64 `locationName:"totalServers" type:"integer"` } @@ -2921,6 +3596,12 @@ func (s *AppSummary) SetDescription(v string) *AppSummary { return s } +// SetImportedAppId sets the ImportedAppId field's value. +func (s *AppSummary) SetImportedAppId(v string) *AppSummary { + s.ImportedAppId = &v + return s +} + // SetLastModified sets the LastModified field's value. func (s *AppSummary) SetLastModified(v time.Time) *AppSummary { s.LastModified = &v @@ -2933,6 +3614,12 @@ func (s *AppSummary) SetLatestReplicationTime(v time.Time) *AppSummary { return s } +// SetLaunchConfigurationStatus sets the LaunchConfigurationStatus field's value. +func (s *AppSummary) SetLaunchConfigurationStatus(v string) *AppSummary { + s.LaunchConfigurationStatus = &v + return s +} + // SetLaunchDetails sets the LaunchDetails field's value. func (s *AppSummary) SetLaunchDetails(v *LaunchDetails) *AppSummary { s.LaunchDetails = v @@ -2957,6 +3644,12 @@ func (s *AppSummary) SetName(v string) *AppSummary { return s } +// SetReplicationConfigurationStatus sets the ReplicationConfigurationStatus field's value. +func (s *AppSummary) SetReplicationConfigurationStatus(v string) *AppSummary { + s.ReplicationConfigurationStatus = &v + return s +} + // SetReplicationStatus sets the ReplicationStatus field's value. func (s *AppSummary) SetReplicationStatus(v string) *AppSummary { s.ReplicationStatus = &v @@ -2999,6 +3692,99 @@ func (s *AppSummary) SetTotalServers(v int64) *AppSummary { return s } +// Configuration for validating an application. +type AppValidationConfiguration struct { + _ struct{} `type:"structure"` + + // The validation strategy. + AppValidationStrategy *string `locationName:"appValidationStrategy" type:"string" enum:"AppValidationStrategy"` + + // The name of the configuration. + Name *string `locationName:"name" min:"1" type:"string"` + + // The validation parameters. + SsmValidationParameters *SSMValidationParameters `locationName:"ssmValidationParameters" type:"structure"` + + // The ID of the validation. + ValidationId *string `locationName:"validationId" type:"string"` +} + +// String returns the string representation +func (s AppValidationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AppValidationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AppValidationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AppValidationConfiguration"} + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.SsmValidationParameters != nil { + if err := s.SsmValidationParameters.Validate(); err != nil { + invalidParams.AddNested("SsmValidationParameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppValidationStrategy sets the AppValidationStrategy field's value. +func (s *AppValidationConfiguration) SetAppValidationStrategy(v string) *AppValidationConfiguration { + s.AppValidationStrategy = &v + return s +} + +// SetName sets the Name field's value. +func (s *AppValidationConfiguration) SetName(v string) *AppValidationConfiguration { + s.Name = &v + return s +} + +// SetSsmValidationParameters sets the SsmValidationParameters field's value. +func (s *AppValidationConfiguration) SetSsmValidationParameters(v *SSMValidationParameters) *AppValidationConfiguration { + s.SsmValidationParameters = v + return s +} + +// SetValidationId sets the ValidationId field's value. +func (s *AppValidationConfiguration) SetValidationId(v string) *AppValidationConfiguration { + s.ValidationId = &v + return s +} + +// Output from validating an application. +type AppValidationOutput struct { + _ struct{} `type:"structure"` + + // Output from using SSM to validate the application. + SsmOutput *SSMOutput `locationName:"ssmOutput" type:"structure"` +} + +// String returns the string representation +func (s AppValidationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AppValidationOutput) GoString() string { + return s.String() +} + +// SetSsmOutput sets the SsmOutput field's value. +func (s *AppValidationOutput) SetSsmOutput(v *SSMOutput) *AppValidationOutput { + s.SsmOutput = v + return s +} + // Represents a connector. type Connector struct { _ struct{} `type:"structure"` @@ -3009,7 +3795,7 @@ type Connector struct { // The capabilities of the connector. CapabilityList []*string `locationName:"capabilityList" type:"list"` - // The identifier of the connector. + // The ID of the connector. ConnectorId *string `locationName:"connectorId" type:"string"` // The IP address of the connector. @@ -3024,7 +3810,7 @@ type Connector struct { // The connector version. Version *string `locationName:"version" type:"string"` - // The identifier of the VM manager. + // The ID of the VM manager. VmManagerId *string `locationName:"vmManagerId" type:"string"` // The name of the VM manager. @@ -3107,23 +3893,24 @@ func (s *Connector) SetVmManagerType(v string) *Connector { type CreateAppInput struct { _ struct{} `type:"structure"` - // A unique, case-sensitive identifier you provide to ensure idempotency of - // application creation. + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of application creation. ClientToken *string `locationName:"clientToken" type:"string"` - // Description of the new application + // The description of the new application Description *string `locationName:"description" type:"string"` - // Name of the new application. + // The name of the new application. Name *string `locationName:"name" type:"string"` - // Name of service role in customer's account to be used by AWS SMS. + // The name of the service role in the customer's account to be used by AWS + // SMS. RoleName *string `locationName:"roleName" type:"string"` - // List of server groups to include in the application. + // The server groups to include in the application. ServerGroups []*ServerGroup `locationName:"serverGroups" type:"list"` - // List of tags to be associated with the application. + // The tags to be associated with the application. Tags []*Tag `locationName:"tags" type:"list"` } @@ -3176,13 +3963,13 @@ func (s *CreateAppInput) SetTags(v []*Tag) *CreateAppInput { type CreateAppOutput struct { _ struct{} `type:"structure"` - // Summary description of the application. + // A summary description of the application. AppSummary *AppSummary `locationName:"appSummary" type:"structure"` - // List of server groups included in the application. + // The server groups included in the application. ServerGroups []*ServerGroup `locationName:"serverGroups" type:"list"` - // List of taags associated with the application. + // The tags associated with the application. Tags []*Tag `locationName:"tags" type:"list"` } @@ -3220,39 +4007,39 @@ type CreateReplicationJobInput struct { // The description of the replication job. Description *string `locationName:"description" type:"string"` - // When true, the replication job produces encrypted AMIs. See also KmsKeyId - // below. + // Indicates whether the replication job produces encrypted AMIs. Encrypted *bool `locationName:"encrypted" type:"boolean"` // The time between consecutive replication runs, in hours. Frequency *int64 `locationName:"frequency" type:"integer"` - // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of - // the following: + // The ID of the KMS key for replication jobs that produce encrypted AMIs. This + // value can be any of the following: // // * KMS key ID // // * KMS key alias // - // * ARN referring to KMS key ID + // * ARN referring to the KMS key ID // - // * ARN referring to KMS key alias + // * ARN referring to the KMS key alias // - // If encrypted is true but a KMS key id is not specified, the customer's default - // KMS key for EBS is used. + // If encrypted is true but a KMS key ID is not specified, the customer's default + // KMS key for Amazon EBS is used. KmsKeyId *string `locationName:"kmsKeyId" type:"string"` // The license type to be used for the AMI created by a successful replication // run. LicenseType *string `locationName:"licenseType" type:"string" enum:"LicenseType"` - // The maximum number of SMS-created AMIs to retain. The oldest will be deleted - // once the maximum number is reached and a new AMI is created. + // The maximum number of SMS-created AMIs to retain. The oldest is deleted after + // the maximum number is reached and a new AMI is created. NumberOfRecentAmisToKeep *int64 `locationName:"numberOfRecentAmisToKeep" type:"integer"` // The name of the IAM role to be used by the AWS SMS. RoleName *string `locationName:"roleName" type:"string"` + // Indicates whether to run the replication job one time. RunOnce *bool `locationName:"runOnce" type:"boolean"` // The seed replication time. @@ -3260,7 +4047,7 @@ type CreateReplicationJobInput struct { // SeedReplicationTime is a required field SeedReplicationTime *time.Time `locationName:"seedReplicationTime" type:"timestamp" required:"true"` - // The identifier of the server. + // The ID of the server. // // ServerId is a required field ServerId *string `locationName:"serverId" type:"string" required:"true"` @@ -3378,15 +4165,15 @@ func (s *CreateReplicationJobOutput) SetReplicationJobId(v string) *CreateReplic type DeleteAppInput struct { _ struct{} `type:"structure"` - // ID of the application to delete. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` - // While deleting the application, stop all replication jobs corresponding to - // the servers in the application. + // Indicates whether to stop all replication jobs corresponding to the servers + // in the application while deleting the application. ForceStopAppReplication *bool `locationName:"forceStopAppReplication" type:"boolean"` - // While deleting the application, terminate the stack corresponding to the - // application. + // Indicates whether to terminate the stack corresponding to the application + // while deleting the application. ForceTerminateApp *bool `locationName:"forceTerminateApp" type:"boolean"` } @@ -3421,7 +4208,7 @@ func (s *DeleteAppInput) SetForceTerminateApp(v bool) *DeleteAppInput { type DeleteAppLaunchConfigurationInput struct { _ struct{} `type:"structure"` - // ID of the application associated with the launch configuration. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -3472,7 +4259,7 @@ func (s DeleteAppOutput) GoString() string { type DeleteAppReplicationConfigurationInput struct { _ struct{} `type:"structure"` - // ID of the application associated with the replication configuration. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -3481,35 +4268,87 @@ func (s DeleteAppReplicationConfigurationInput) String() string { return awsutil.Prettify(s) } -// GoString returns the string representation -func (s DeleteAppReplicationConfigurationInput) GoString() string { - return s.String() +// GoString returns the string representation +func (s DeleteAppReplicationConfigurationInput) GoString() string { + return s.String() +} + +// SetAppId sets the AppId field's value. +func (s *DeleteAppReplicationConfigurationInput) SetAppId(v string) *DeleteAppReplicationConfigurationInput { + s.AppId = &v + return s +} + +type DeleteAppReplicationConfigurationOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteAppReplicationConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAppReplicationConfigurationOutput) GoString() string { + return s.String() +} + +type DeleteAppValidationConfigurationInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // AppId is a required field + AppId *string `locationName:"appId" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteAppValidationConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAppValidationConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAppValidationConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAppValidationConfigurationInput"} + if s.AppId == nil { + invalidParams.Add(request.NewErrParamRequired("AppId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } // SetAppId sets the AppId field's value. -func (s *DeleteAppReplicationConfigurationInput) SetAppId(v string) *DeleteAppReplicationConfigurationInput { +func (s *DeleteAppValidationConfigurationInput) SetAppId(v string) *DeleteAppValidationConfigurationInput { s.AppId = &v return s } -type DeleteAppReplicationConfigurationOutput struct { +type DeleteAppValidationConfigurationOutput struct { _ struct{} `type:"structure"` } // String returns the string representation -func (s DeleteAppReplicationConfigurationOutput) String() string { +func (s DeleteAppValidationConfigurationOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteAppReplicationConfigurationOutput) GoString() string { +func (s DeleteAppValidationConfigurationOutput) GoString() string { return s.String() } type DeleteReplicationJobInput struct { _ struct{} `type:"structure"` - // The identifier of the replication job. + // The ID of the replication job. // // ReplicationJobId is a required field ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"` @@ -3589,7 +4428,7 @@ func (s DeleteServerCatalogOutput) GoString() string { type DisassociateConnectorInput struct { _ struct{} `type:"structure"` - // The identifier of the connector. + // The ID of the connector. // // ConnectorId is a required field ConnectorId *string `locationName:"connectorId" type:"string" required:"true"` @@ -3638,13 +4477,70 @@ func (s DisassociateConnectorOutput) GoString() string { return s.String() } +// The user has the required permissions, so the request would have succeeded, +// but a dry run was performed. +type DryRunOperationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s DryRunOperationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DryRunOperationException) GoString() string { + return s.String() +} + +func newErrorDryRunOperationException(v protocol.ResponseMetadata) error { + return &DryRunOperationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *DryRunOperationException) Code() string { + return "DryRunOperationException" +} + +// Message returns the exception's message. +func (s *DryRunOperationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *DryRunOperationException) OrigErr() error { + return nil +} + +func (s *DryRunOperationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *DryRunOperationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *DryRunOperationException) RequestID() string { + return s.RespMetadata.RequestID +} + type GenerateChangeSetInput struct { _ struct{} `type:"structure"` - // ID of the application associated with the change set. + // The ID of the application associated with the change set. AppId *string `locationName:"appId" type:"string"` - // Format for the change set. + // The format for the change set. ChangesetFormat *string `locationName:"changesetFormat" type:"string" enum:"OutputFormat"` } @@ -3673,7 +4569,7 @@ func (s *GenerateChangeSetInput) SetChangesetFormat(v string) *GenerateChangeSet type GenerateChangeSetOutput struct { _ struct{} `type:"structure"` - // Location of the Amazon S3 object. + // The location of the Amazon S3 object. S3Location *S3Location `locationName:"s3Location" type:"structure"` } @@ -3696,10 +4592,10 @@ func (s *GenerateChangeSetOutput) SetS3Location(v *S3Location) *GenerateChangeSe type GenerateTemplateInput struct { _ struct{} `type:"structure"` - // ID of the application associated with the Amazon CloudFormation template. + // The ID of the application associated with the AWS CloudFormation template. AppId *string `locationName:"appId" type:"string"` - // Format for generating the Amazon CloudFormation template. + // The format for generating the AWS CloudFormation template. TemplateFormat *string `locationName:"templateFormat" type:"string" enum:"OutputFormat"` } @@ -3728,7 +4624,7 @@ func (s *GenerateTemplateInput) SetTemplateFormat(v string) *GenerateTemplateInp type GenerateTemplateOutput struct { _ struct{} `type:"structure"` - // Location of the Amazon S3 object. + // The location of the Amazon S3 object. S3Location *S3Location `locationName:"s3Location" type:"structure"` } @@ -3751,7 +4647,7 @@ func (s *GenerateTemplateOutput) SetS3Location(v *S3Location) *GenerateTemplateO type GetAppInput struct { _ struct{} `type:"structure"` - // ID of the application whose information is being retrieved. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -3774,7 +4670,7 @@ func (s *GetAppInput) SetAppId(v string) *GetAppInput { type GetAppLaunchConfigurationInput struct { _ struct{} `type:"structure"` - // ID of the application launch configuration. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -3797,14 +4693,18 @@ func (s *GetAppLaunchConfigurationInput) SetAppId(v string) *GetAppLaunchConfigu type GetAppLaunchConfigurationOutput struct { _ struct{} `type:"structure"` - // ID of the application associated with the launch configuration. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` - // Name of the service role in the customer's account that Amazon CloudFormation + // Indicates whether the application is configured to launch automatically after + // replication is complete. + AutoLaunch *bool `locationName:"autoLaunch" type:"boolean"` + + // The name of the service role in the customer's account that AWS CloudFormation // uses to launch the application. RoleName *string `locationName:"roleName" type:"string"` - // List of launch configurations for server groups in this application. + // The launch configurations for server groups in this application. ServerGroupLaunchConfigurations []*ServerGroupLaunchConfiguration `locationName:"serverGroupLaunchConfigurations" type:"list"` } @@ -3824,6 +4724,12 @@ func (s *GetAppLaunchConfigurationOutput) SetAppId(v string) *GetAppLaunchConfig return s } +// SetAutoLaunch sets the AutoLaunch field's value. +func (s *GetAppLaunchConfigurationOutput) SetAutoLaunch(v bool) *GetAppLaunchConfigurationOutput { + s.AutoLaunch = &v + return s +} + // SetRoleName sets the RoleName field's value. func (s *GetAppLaunchConfigurationOutput) SetRoleName(v string) *GetAppLaunchConfigurationOutput { s.RoleName = &v @@ -3842,10 +4748,10 @@ type GetAppOutput struct { // Information about the application. AppSummary *AppSummary `locationName:"appSummary" type:"structure"` - // List of server groups belonging to the application. + // The server groups that belong to the application. ServerGroups []*ServerGroup `locationName:"serverGroups" type:"list"` - // List of tags associated with the application. + // The tags associated with the application. Tags []*Tag `locationName:"tags" type:"list"` } @@ -3880,7 +4786,7 @@ func (s *GetAppOutput) SetTags(v []*Tag) *GetAppOutput { type GetAppReplicationConfigurationInput struct { _ struct{} `type:"structure"` - // ID of the application associated with the replication configuration. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -3903,7 +4809,7 @@ func (s *GetAppReplicationConfigurationInput) SetAppId(v string) *GetAppReplicat type GetAppReplicationConfigurationOutput struct { _ struct{} `type:"structure"` - // Replication configurations associated with server groups in this application. + // The replication configurations associated with server groups in this application. ServerGroupReplicationConfigurations []*ServerGroupReplicationConfiguration `locationName:"serverGroupReplicationConfigurations" type:"list"` } @@ -3923,6 +4829,137 @@ func (s *GetAppReplicationConfigurationOutput) SetServerGroupReplicationConfigur return s } +type GetAppValidationConfigurationInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // AppId is a required field + AppId *string `locationName:"appId" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetAppValidationConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAppValidationConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAppValidationConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAppValidationConfigurationInput"} + if s.AppId == nil { + invalidParams.Add(request.NewErrParamRequired("AppId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppId sets the AppId field's value. +func (s *GetAppValidationConfigurationInput) SetAppId(v string) *GetAppValidationConfigurationInput { + s.AppId = &v + return s +} + +type GetAppValidationConfigurationOutput struct { + _ struct{} `type:"structure"` + + // The configuration for application validation. + AppValidationConfigurations []*AppValidationConfiguration `locationName:"appValidationConfigurations" type:"list"` + + // The configuration for instance validation. + ServerGroupValidationConfigurations []*ServerGroupValidationConfiguration `locationName:"serverGroupValidationConfigurations" type:"list"` +} + +// String returns the string representation +func (s GetAppValidationConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAppValidationConfigurationOutput) GoString() string { + return s.String() +} + +// SetAppValidationConfigurations sets the AppValidationConfigurations field's value. +func (s *GetAppValidationConfigurationOutput) SetAppValidationConfigurations(v []*AppValidationConfiguration) *GetAppValidationConfigurationOutput { + s.AppValidationConfigurations = v + return s +} + +// SetServerGroupValidationConfigurations sets the ServerGroupValidationConfigurations field's value. +func (s *GetAppValidationConfigurationOutput) SetServerGroupValidationConfigurations(v []*ServerGroupValidationConfiguration) *GetAppValidationConfigurationOutput { + s.ServerGroupValidationConfigurations = v + return s +} + +type GetAppValidationOutputInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // AppId is a required field + AppId *string `locationName:"appId" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetAppValidationOutputInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAppValidationOutputInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAppValidationOutputInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAppValidationOutputInput"} + if s.AppId == nil { + invalidParams.Add(request.NewErrParamRequired("AppId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppId sets the AppId field's value. +func (s *GetAppValidationOutputInput) SetAppId(v string) *GetAppValidationOutputInput { + s.AppId = &v + return s +} + +type GetAppValidationOutputOutput struct { + _ struct{} `type:"structure"` + + // The validation output. + ValidationOutputList []*ValidationOutput `locationName:"validationOutputList" type:"list"` +} + +// String returns the string representation +func (s GetAppValidationOutputOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAppValidationOutputOutput) GoString() string { + return s.String() +} + +// SetValidationOutputList sets the ValidationOutputList field's value. +func (s *GetAppValidationOutputOutput) SetValidationOutputList(v []*ValidationOutput) *GetAppValidationOutputOutput { + s.ValidationOutputList = v + return s +} + type GetConnectorsInput struct { _ struct{} `type:"structure"` @@ -4001,7 +5038,7 @@ type GetReplicationJobsInput struct { // The token for the next set of results. NextToken *string `locationName:"nextToken" type:"string"` - // The identifier of the replication job. + // The ID of the replication job. ReplicationJobId *string `locationName:"replicationJobId" type:"string"` } @@ -4077,7 +5114,7 @@ type GetReplicationRunsInput struct { // The token for the next set of results. NextToken *string `locationName:"nextToken" type:"string"` - // The identifier of the replication job. + // The ID of the replication job. // // ReplicationJobId is a required field ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"` @@ -4177,7 +5214,7 @@ type GetServersInput struct { // The token for the next set of results. NextToken *string `locationName:"nextToken" type:"string"` - // List of VmServerAddress objects + // The server addresses. VmServerAddressList []*VmServerAddress `locationName:"vmServerAddressList" type:"list"` } @@ -4260,6 +5297,46 @@ func (s *GetServersOutput) SetServerList(v []*Server) *GetServersOutput { return s } +type ImportAppCatalogInput struct { + _ struct{} `type:"structure"` + + // The name of the service role. If you omit this parameter, we create a service-linked + // role for AWS Migration Hub in your account. Otherwise, the role that you + // provide must have the policy and trust policy (https://docs.aws.amazon.com/migrationhub/latest/ug/new-customer-setup.html#sms-managed) + // described in the AWS Migration Hub User Guide. + RoleName *string `locationName:"roleName" type:"string"` +} + +// String returns the string representation +func (s ImportAppCatalogInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ImportAppCatalogInput) GoString() string { + return s.String() +} + +// SetRoleName sets the RoleName field's value. +func (s *ImportAppCatalogInput) SetRoleName(v string) *ImportAppCatalogInput { + s.RoleName = &v + return s +} + +type ImportAppCatalogOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s ImportAppCatalogOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ImportAppCatalogOutput) GoString() string { + return s.String() +} + type ImportServerCatalogInput struct { _ struct{} `type:"structure"` } @@ -4403,7 +5480,7 @@ func (s *InvalidParameterException) RequestID() string { type LaunchAppInput struct { _ struct{} `type:"structure"` - // ID of the application to launch. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -4441,13 +5518,13 @@ func (s LaunchAppOutput) GoString() string { type LaunchDetails struct { _ struct{} `type:"structure"` - // Latest time this application was launched successfully. + // The latest time that this application was launched successfully. LatestLaunchTime *time.Time `locationName:"latestLaunchTime" type:"timestamp"` - // Identifier of the latest stack launched for this application. + // The ID of the latest stack launched for this application. StackId *string `locationName:"stackId" type:"string"` - // Name of the latest stack launched for this application. + // The name of the latest stack launched for this application. StackName *string `locationName:"stackName" type:"string"` } @@ -4482,10 +5559,11 @@ func (s *LaunchDetails) SetStackName(v string) *LaunchDetails { type ListAppsInput struct { _ struct{} `type:"structure"` + // The unique application IDs. AppIds []*string `locationName:"appIds" type:"list"` // The maximum number of results to return in a single call. The default value - // is 50. To retrieve the remaining results, make another call with the returned + // is 100. To retrieve the remaining results, make another call with the returned // NextToken value. MaxResults *int64 `locationName:"maxResults" type:"integer"` @@ -4524,7 +5602,7 @@ func (s *ListAppsInput) SetNextToken(v string) *ListAppsInput { type ListAppsOutput struct { _ struct{} `type:"structure"` - // A list of application summaries. + // The application summaries. Apps []*AppSummary `locationName:"apps" type:"list"` // The token required to retrieve the next set of results. This value is null @@ -4615,55 +5693,158 @@ type NoConnectorsAvailableException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - Message_ *string `locationName:"message" type:"string"` + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s NoConnectorsAvailableException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s NoConnectorsAvailableException) GoString() string { + return s.String() +} + +func newErrorNoConnectorsAvailableException(v protocol.ResponseMetadata) error { + return &NoConnectorsAvailableException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *NoConnectorsAvailableException) Code() string { + return "NoConnectorsAvailableException" +} + +// Message returns the exception's message. +func (s *NoConnectorsAvailableException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *NoConnectorsAvailableException) OrigErr() error { + return nil +} + +func (s *NoConnectorsAvailableException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *NoConnectorsAvailableException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *NoConnectorsAvailableException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Contains the status of validating an application. +type NotificationContext struct { + _ struct{} `type:"structure"` + + // The status of the validation. + Status *string `locationName:"status" type:"string" enum:"ValidationStatus"` + + // The status message. + StatusMessage *string `locationName:"statusMessage" type:"string"` + + // The ID of the validation. + ValidationId *string `locationName:"validationId" type:"string"` +} + +// String returns the string representation +func (s NotificationContext) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s NotificationContext) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *NotificationContext) SetStatus(v string) *NotificationContext { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *NotificationContext) SetStatusMessage(v string) *NotificationContext { + s.StatusMessage = &v + return s +} + +// SetValidationId sets the ValidationId field's value. +func (s *NotificationContext) SetValidationId(v string) *NotificationContext { + s.ValidationId = &v + return s +} + +type NotifyAppValidationOutputInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // AppId is a required field + AppId *string `locationName:"appId" type:"string" required:"true"` + + // The notification information. + NotificationContext *NotificationContext `locationName:"notificationContext" type:"structure"` } // String returns the string representation -func (s NoConnectorsAvailableException) String() string { +func (s NotifyAppValidationOutputInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s NoConnectorsAvailableException) GoString() string { +func (s NotifyAppValidationOutputInput) GoString() string { return s.String() } -func newErrorNoConnectorsAvailableException(v protocol.ResponseMetadata) error { - return &NoConnectorsAvailableException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *NotifyAppValidationOutputInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "NotifyAppValidationOutputInput"} + if s.AppId == nil { + invalidParams.Add(request.NewErrParamRequired("AppId")) } -} -// Code returns the exception type name. -func (s *NoConnectorsAvailableException) Code() string { - return "NoConnectorsAvailableException" + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// Message returns the exception's message. -func (s *NoConnectorsAvailableException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetAppId sets the AppId field's value. +func (s *NotifyAppValidationOutputInput) SetAppId(v string) *NotifyAppValidationOutputInput { + s.AppId = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *NoConnectorsAvailableException) OrigErr() error { - return nil +// SetNotificationContext sets the NotificationContext field's value. +func (s *NotifyAppValidationOutputInput) SetNotificationContext(v *NotificationContext) *NotifyAppValidationOutputInput { + s.NotificationContext = v + return s } -func (s *NoConnectorsAvailableException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +type NotifyAppValidationOutputOutput struct { + _ struct{} `type:"structure"` } -// Status code returns the HTTP status code for the request's response error. -func (s *NoConnectorsAvailableException) StatusCode() int { - return s.RespMetadata.StatusCode +// String returns the string representation +func (s NotifyAppValidationOutputOutput) String() string { + return awsutil.Prettify(s) } -// RequestID returns the service's response RequestID for request. -func (s *NoConnectorsAvailableException) RequestID() string { - return s.RespMetadata.RequestID +// GoString returns the string representation +func (s NotifyAppValidationOutputOutput) GoString() string { + return s.String() } // This operation is not allowed. @@ -4725,14 +5906,18 @@ func (s *OperationNotPermittedException) RequestID() string { type PutAppLaunchConfigurationInput struct { _ struct{} `type:"structure"` - // ID of the application associated with the launch configuration. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` - // Name of service role in the customer's account that Amazon CloudFormation + // Indicates whether the application is configured to launch automatically after + // replication is complete. + AutoLaunch *bool `locationName:"autoLaunch" type:"boolean"` + + // The name of service role in the customer's account that AWS CloudFormation // uses to launch the application. RoleName *string `locationName:"roleName" type:"string"` - // Launch configurations for server groups in the application. + // Information about the launch configurations for server groups in the application. ServerGroupLaunchConfigurations []*ServerGroupLaunchConfiguration `locationName:"serverGroupLaunchConfigurations" type:"list"` } @@ -4746,12 +5931,38 @@ func (s PutAppLaunchConfigurationInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutAppLaunchConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutAppLaunchConfigurationInput"} + if s.ServerGroupLaunchConfigurations != nil { + for i, v := range s.ServerGroupLaunchConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ServerGroupLaunchConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAppId sets the AppId field's value. func (s *PutAppLaunchConfigurationInput) SetAppId(v string) *PutAppLaunchConfigurationInput { s.AppId = &v return s } +// SetAutoLaunch sets the AutoLaunch field's value. +func (s *PutAppLaunchConfigurationInput) SetAutoLaunch(v bool) *PutAppLaunchConfigurationInput { + s.AutoLaunch = &v + return s +} + // SetRoleName sets the RoleName field's value. func (s *PutAppLaunchConfigurationInput) SetRoleName(v string) *PutAppLaunchConfigurationInput { s.RoleName = &v @@ -4781,10 +5992,11 @@ func (s PutAppLaunchConfigurationOutput) GoString() string { type PutAppReplicationConfigurationInput struct { _ struct{} `type:"structure"` - // ID of the application tassociated with the replication configuration. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` - // Replication configurations for server groups in the application. + // Information about the replication configurations for server groups in the + // application. ServerGroupReplicationConfigurations []*ServerGroupReplicationConfiguration `locationName:"serverGroupReplicationConfigurations" type:"list"` } @@ -4824,6 +6036,96 @@ func (s PutAppReplicationConfigurationOutput) GoString() string { return s.String() } +type PutAppValidationConfigurationInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // AppId is a required field + AppId *string `locationName:"appId" type:"string" required:"true"` + + // The configuration for application validation. + AppValidationConfigurations []*AppValidationConfiguration `locationName:"appValidationConfigurations" type:"list"` + + // The configuration for instance validation. + ServerGroupValidationConfigurations []*ServerGroupValidationConfiguration `locationName:"serverGroupValidationConfigurations" type:"list"` +} + +// String returns the string representation +func (s PutAppValidationConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutAppValidationConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutAppValidationConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutAppValidationConfigurationInput"} + if s.AppId == nil { + invalidParams.Add(request.NewErrParamRequired("AppId")) + } + if s.AppValidationConfigurations != nil { + for i, v := range s.AppValidationConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AppValidationConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } + if s.ServerGroupValidationConfigurations != nil { + for i, v := range s.ServerGroupValidationConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ServerGroupValidationConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppId sets the AppId field's value. +func (s *PutAppValidationConfigurationInput) SetAppId(v string) *PutAppValidationConfigurationInput { + s.AppId = &v + return s +} + +// SetAppValidationConfigurations sets the AppValidationConfigurations field's value. +func (s *PutAppValidationConfigurationInput) SetAppValidationConfigurations(v []*AppValidationConfiguration) *PutAppValidationConfigurationInput { + s.AppValidationConfigurations = v + return s +} + +// SetServerGroupValidationConfigurations sets the ServerGroupValidationConfigurations field's value. +func (s *PutAppValidationConfigurationInput) SetServerGroupValidationConfigurations(v []*ServerGroupValidationConfiguration) *PutAppValidationConfigurationInput { + s.ServerGroupValidationConfigurations = v + return s +} + +type PutAppValidationConfigurationOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s PutAppValidationConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutAppValidationConfigurationOutput) GoString() string { + return s.String() +} + // Represents a replication job. type ReplicationJob struct { _ struct{} `type:"structure"` @@ -4831,26 +6133,25 @@ type ReplicationJob struct { // The description of the replication job. Description *string `locationName:"description" type:"string"` - // Whether the replication job should produce encrypted AMIs or not. See also - // KmsKeyId below. + // Indicates whether the replication job should produce encrypted AMIs. Encrypted *bool `locationName:"encrypted" type:"boolean"` // The time between consecutive replication runs, in hours. Frequency *int64 `locationName:"frequency" type:"integer"` - // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of - // the following: + // The ID of the KMS key for replication jobs that produce encrypted AMIs. This + // value can be any of the following: // // * KMS key ID // // * KMS key alias // - // * ARN referring to KMS key ID + // * ARN referring to the KMS key ID // - // * ARN referring to KMS key alias + // * ARN referring to the KMS key alias // - // If encrypted is true but a KMS key id is not specified, the customer's default - // KMS key for EBS is used. + // If encrypted is enabled but a KMS key ID is not specified, the customer's + // default KMS key for Amazon EBS is used. KmsKeyId *string `locationName:"kmsKeyId" type:"string"` // The ID of the latest Amazon Machine Image (AMI). @@ -4863,25 +6164,26 @@ type ReplicationJob struct { // The start time of the next replication run. NextReplicationRunStartTime *time.Time `locationName:"nextReplicationRunStartTime" type:"timestamp"` - // Number of recent AMIs to keep in the customer's account for a replication - // job. By default the value is set to zero, meaning that all AMIs are kept. + // The number of recent AMIs to keep in the customer's account for a replication + // job. By default, the value is set to zero, meaning that all AMIs are kept. NumberOfRecentAmisToKeep *int64 `locationName:"numberOfRecentAmisToKeep" type:"integer"` - // The identifier of the replication job. + // The ID of the replication job. ReplicationJobId *string `locationName:"replicationJobId" type:"string"` // Information about the replication runs. ReplicationRunList []*ReplicationRun `locationName:"replicationRunList" type:"list"` - // The name of the IAM role to be used by the Server Migration Service. + // The name of the IAM role to be used by AWS SMS. RoleName *string `locationName:"roleName" type:"string"` + // Indicates whether to run the replication job one time. RunOnce *bool `locationName:"runOnce" type:"boolean"` // The seed replication time. SeedReplicationTime *time.Time `locationName:"seedReplicationTime" type:"timestamp"` - // The identifier of the server. + // The ID of the server. ServerId *string `locationName:"serverId" type:"string"` // The type of server. @@ -5131,7 +6433,7 @@ func (s *ReplicationJobNotFoundException) RequestID() string { type ReplicationRun struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Machine Image (AMI) from the replication run. + // The ID of the Amazon Machine Image (AMI) from the replication run. AmiId *string `locationName:"amiId" type:"string"` // The completion time of the last replication run. @@ -5140,32 +6442,31 @@ type ReplicationRun struct { // The description of the replication run. Description *string `locationName:"description" type:"string"` - // Whether the replication run should produce encrypted AMI or not. See also - // KmsKeyId below. + // Indicates whether the replication run should produce an encrypted AMI. Encrypted *bool `locationName:"encrypted" type:"boolean"` - // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of - // the following: + // The ID of the KMS key for replication jobs that produce encrypted AMIs. This + // value can be any of the following: // // * KMS key ID // // * KMS key alias // - // * ARN referring to KMS key ID + // * ARN referring to the KMS key ID // - // * ARN referring to KMS key alias + // * ARN referring to the KMS key alias // - // If encrypted is true but a KMS key id is not specified, the customer's default - // KMS key for EBS is used. + // If encrypted is true but a KMS key ID is not specified, the customer's default + // KMS key for Amazon EBS is used. KmsKeyId *string `locationName:"kmsKeyId" type:"string"` - // The identifier of the replication run. + // The ID of the replication run. ReplicationRunId *string `locationName:"replicationRunId" type:"string"` // The start time of the next replication run. ScheduledStartTime *time.Time `locationName:"scheduledStartTime" type:"timestamp"` - // Details of the current stage of the replication run. + // Details about the current stage of the replication run. StageDetails *ReplicationRunStageDetails `locationName:"stageDetails" type:"structure"` // The state of the replication run. @@ -5315,10 +6616,10 @@ func (s *ReplicationRunLimitExceededException) RequestID() string { type ReplicationRunStageDetails struct { _ struct{} `type:"structure"` - // String describing the current stage of a replication run. + // The current stage of a replication run. Stage *string `locationName:"stage" type:"string"` - // String describing the progress of the current stage of a replication run. + // The progress of the current stage of a replication run. StageProgress *string `locationName:"stageProgress" type:"string"` } @@ -5344,14 +6645,14 @@ func (s *ReplicationRunStageDetails) SetStageProgress(v string) *ReplicationRunS return s } -// Location of the Amazon S3 object in the customer's account. +// Location of an Amazon S3 object. type S3Location struct { _ struct{} `type:"structure"` - // Amazon S3 bucket name. - Bucket *string `locationName:"bucket" type:"string"` + // The Amazon S3 bucket name. + Bucket *string `locationName:"bucket" min:"3" type:"string"` - // Amazon S3 bucket key. + // The Amazon S3 bucket key. Key *string `locationName:"key" type:"string"` } @@ -5365,6 +6666,19 @@ func (s S3Location) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3Location) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3Location"} + if s.Bucket != nil && len(*s.Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Bucket", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetBucket sets the Bucket field's value. func (s *S3Location) SetBucket(v string) *S3Location { s.Bucket = &v @@ -5377,17 +6691,131 @@ func (s *S3Location) SetKey(v string) *S3Location { return s } +// Contains the location of validation output. +type SSMOutput struct { + _ struct{} `type:"structure"` + + // Location of an Amazon S3 object. + S3Location *S3Location `locationName:"s3Location" type:"structure"` +} + +// String returns the string representation +func (s SSMOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SSMOutput) GoString() string { + return s.String() +} + +// SetS3Location sets the S3Location field's value. +func (s *SSMOutput) SetS3Location(v *S3Location) *SSMOutput { + s.S3Location = v + return s +} + +// Contains validation parameters. +type SSMValidationParameters struct { + _ struct{} `type:"structure"` + + // The command to run the validation script + Command *string `locationName:"command" min:"1" type:"string"` + + // The timeout interval, in seconds. + ExecutionTimeoutSeconds *int64 `locationName:"executionTimeoutSeconds" min:"60" type:"integer"` + + // The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true. + InstanceId *string `locationName:"instanceId" type:"string"` + + // The name of the S3 bucket for output. + OutputS3BucketName *string `locationName:"outputS3BucketName" type:"string"` + + // The type of validation script. + ScriptType *string `locationName:"scriptType" type:"string" enum:"ScriptType"` + + // The location of the validation script. + Source *Source `locationName:"source" type:"structure"` +} + +// String returns the string representation +func (s SSMValidationParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SSMValidationParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SSMValidationParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SSMValidationParameters"} + if s.Command != nil && len(*s.Command) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Command", 1)) + } + if s.ExecutionTimeoutSeconds != nil && *s.ExecutionTimeoutSeconds < 60 { + invalidParams.Add(request.NewErrParamMinValue("ExecutionTimeoutSeconds", 60)) + } + if s.Source != nil { + if err := s.Source.Validate(); err != nil { + invalidParams.AddNested("Source", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCommand sets the Command field's value. +func (s *SSMValidationParameters) SetCommand(v string) *SSMValidationParameters { + s.Command = &v + return s +} + +// SetExecutionTimeoutSeconds sets the ExecutionTimeoutSeconds field's value. +func (s *SSMValidationParameters) SetExecutionTimeoutSeconds(v int64) *SSMValidationParameters { + s.ExecutionTimeoutSeconds = &v + return s +} + +// SetInstanceId sets the InstanceId field's value. +func (s *SSMValidationParameters) SetInstanceId(v string) *SSMValidationParameters { + s.InstanceId = &v + return s +} + +// SetOutputS3BucketName sets the OutputS3BucketName field's value. +func (s *SSMValidationParameters) SetOutputS3BucketName(v string) *SSMValidationParameters { + s.OutputS3BucketName = &v + return s +} + +// SetScriptType sets the ScriptType field's value. +func (s *SSMValidationParameters) SetScriptType(v string) *SSMValidationParameters { + s.ScriptType = &v + return s +} + +// SetSource sets the Source field's value. +func (s *SSMValidationParameters) SetSource(v *Source) *SSMValidationParameters { + s.Source = v + return s +} + // Represents a server. type Server struct { _ struct{} `type:"structure"` - // The identifier of the replication job. + // The ID of the replication job. ReplicationJobId *string `locationName:"replicationJobId" type:"string"` // Indicates whether the replication job is deleted or failed. ReplicationJobTerminated *bool `locationName:"replicationJobTerminated" type:"boolean"` - // The identifier of the server. + // The ID of the server. ServerId *string `locationName:"serverId" type:"string"` // The type of server. @@ -5493,17 +6921,17 @@ func (s *ServerCannotBeReplicatedException) RequestID() string { return s.RespMetadata.RequestID } -// A logical grouping of servers. +// Logical grouping of servers. type ServerGroup struct { _ struct{} `type:"structure"` - // Name of a server group. + // The name of a server group. Name *string `locationName:"name" type:"string"` - // Identifier of a server group. + // The ID of a server group. ServerGroupId *string `locationName:"serverGroupId" type:"string"` - // List of servers belonging to a server group. + // The servers that belong to a server group. ServerList []*Server `locationName:"serverList" type:"list"` } @@ -5539,13 +6967,13 @@ func (s *ServerGroup) SetServerList(v []*Server) *ServerGroup { type ServerGroupLaunchConfiguration struct { _ struct{} `type:"structure"` - // Launch order of servers in the server group. + // The launch order of servers in the server group. LaunchOrder *int64 `locationName:"launchOrder" type:"integer"` - // Identifier of the server group the launch configuration is associated with. + // The ID of the server group with which the launch configuration is associated. ServerGroupId *string `locationName:"serverGroupId" type:"string"` - // Launch configuration for servers in the server group. + // The launch configuration for servers in the server group. ServerLaunchConfigurations []*ServerLaunchConfiguration `locationName:"serverLaunchConfigurations" type:"list"` } @@ -5559,6 +6987,26 @@ func (s ServerGroupLaunchConfiguration) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ServerGroupLaunchConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ServerGroupLaunchConfiguration"} + if s.ServerLaunchConfigurations != nil { + for i, v := range s.ServerLaunchConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ServerLaunchConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetLaunchOrder sets the LaunchOrder field's value. func (s *ServerGroupLaunchConfiguration) SetLaunchOrder(v int64) *ServerGroupLaunchConfiguration { s.LaunchOrder = &v @@ -5581,11 +7029,10 @@ func (s *ServerGroupLaunchConfiguration) SetServerLaunchConfigurations(v []*Serv type ServerGroupReplicationConfiguration struct { _ struct{} `type:"structure"` - // Identifier of the server group this replication configuration is associated - // with. + // The ID of the server group with which this replication configuration is associated. ServerGroupId *string `locationName:"serverGroupId" type:"string"` - // Replication configuration for servers in the server group. + // The replication configuration for servers in the server group. ServerReplicationConfigurations []*ServerReplicationConfiguration `locationName:"serverReplicationConfigurations" type:"list"` } @@ -5611,35 +7058,99 @@ func (s *ServerGroupReplicationConfiguration) SetServerReplicationConfigurations return s } +// Configuration for validating an instance. +type ServerGroupValidationConfiguration struct { + _ struct{} `type:"structure"` + + // The ID of the server group. + ServerGroupId *string `locationName:"serverGroupId" type:"string"` + + // The validation configuration. + ServerValidationConfigurations []*ServerValidationConfiguration `locationName:"serverValidationConfigurations" type:"list"` +} + +// String returns the string representation +func (s ServerGroupValidationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServerGroupValidationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ServerGroupValidationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ServerGroupValidationConfiguration"} + if s.ServerValidationConfigurations != nil { + for i, v := range s.ServerValidationConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ServerValidationConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetServerGroupId sets the ServerGroupId field's value. +func (s *ServerGroupValidationConfiguration) SetServerGroupId(v string) *ServerGroupValidationConfiguration { + s.ServerGroupId = &v + return s +} + +// SetServerValidationConfigurations sets the ServerValidationConfigurations field's value. +func (s *ServerGroupValidationConfiguration) SetServerValidationConfigurations(v []*ServerValidationConfiguration) *ServerGroupValidationConfiguration { + s.ServerValidationConfigurations = v + return s +} + // Launch configuration for a server. type ServerLaunchConfiguration struct { _ struct{} `type:"structure"` - // If true, a publicly accessible IP address is created when launching the server. + // Indicates whether a publicly accessible IP address is created when launching + // the server. AssociatePublicIpAddress *bool `locationName:"associatePublicIpAddress" type:"boolean"` - // Name of the EC2 SSH Key to be used for connecting to the launched server. + // Location of an Amazon S3 object. + ConfigureScript *S3Location `locationName:"configureScript" type:"structure"` + + // The type of configuration script. + ConfigureScriptType *string `locationName:"configureScriptType" type:"string" enum:"ScriptType"` + + // The name of the Amazon EC2 SSH key to be used for connecting to the launched + // server. Ec2KeyName *string `locationName:"ec2KeyName" type:"string"` - // Instance type to be used for launching the server. + // The name of the IAM instance profile. + IamInstanceProfileName *string `locationName:"iamInstanceProfileName" type:"string"` + + // The instance type to use when launching the server. InstanceType *string `locationName:"instanceType" type:"string"` - // Logical ID of the server in the Amazon CloudFormation template. + // The logical ID of the server in the AWS CloudFormation template. LogicalId *string `locationName:"logicalId" type:"string"` - // Identifier of the security group that applies to the launched server. + // The ID of the security group that applies to the launched server. SecurityGroup *string `locationName:"securityGroup" type:"string"` - // Identifier of the server the launch configuration is associated with. + // The ID of the server with which the launch configuration is associated. Server *Server `locationName:"server" type:"structure"` - // Identifier of the subnet the server should be launched into. + // The ID of the subnet the server should be launched into. Subnet *string `locationName:"subnet" type:"string"` // Location of the user-data script to be executed when launching the server. UserData *UserData `locationName:"userData" type:"structure"` - // Identifier of the VPC the server should be launched into. + // The ID of the VPC into which the server should be launched. Vpc *string `locationName:"vpc" type:"string"` } @@ -5653,18 +7164,56 @@ func (s ServerLaunchConfiguration) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ServerLaunchConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ServerLaunchConfiguration"} + if s.ConfigureScript != nil { + if err := s.ConfigureScript.Validate(); err != nil { + invalidParams.AddNested("ConfigureScript", err.(request.ErrInvalidParams)) + } + } + if s.UserData != nil { + if err := s.UserData.Validate(); err != nil { + invalidParams.AddNested("UserData", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetAssociatePublicIpAddress sets the AssociatePublicIpAddress field's value. func (s *ServerLaunchConfiguration) SetAssociatePublicIpAddress(v bool) *ServerLaunchConfiguration { s.AssociatePublicIpAddress = &v return s } +// SetConfigureScript sets the ConfigureScript field's value. +func (s *ServerLaunchConfiguration) SetConfigureScript(v *S3Location) *ServerLaunchConfiguration { + s.ConfigureScript = v + return s +} + +// SetConfigureScriptType sets the ConfigureScriptType field's value. +func (s *ServerLaunchConfiguration) SetConfigureScriptType(v string) *ServerLaunchConfiguration { + s.ConfigureScriptType = &v + return s +} + // SetEc2KeyName sets the Ec2KeyName field's value. func (s *ServerLaunchConfiguration) SetEc2KeyName(v string) *ServerLaunchConfiguration { s.Ec2KeyName = &v return s } +// SetIamInstanceProfileName sets the IamInstanceProfileName field's value. +func (s *ServerLaunchConfiguration) SetIamInstanceProfileName(v string) *ServerLaunchConfiguration { + s.IamInstanceProfileName = &v + return s +} + // SetInstanceType sets the InstanceType field's value. func (s *ServerLaunchConfiguration) SetInstanceType(v string) *ServerLaunchConfiguration { s.InstanceType = &v @@ -5711,10 +7260,10 @@ func (s *ServerLaunchConfiguration) SetVpc(v string) *ServerLaunchConfiguration type ServerReplicationConfiguration struct { _ struct{} `type:"structure"` - // Identifier of the server this replication configuration is associated with. + // The ID of the server with which this replication configuration is associated. Server *Server `locationName:"server" type:"structure"` - // Parameters for replicating the server. + // The parameters for replicating the server. ServerReplicationParameters *ServerReplicationParameters `locationName:"serverReplicationParameters" type:"structure"` } @@ -5740,41 +7289,42 @@ func (s *ServerReplicationConfiguration) SetServerReplicationParameters(v *Serve return s } -// Replication parameters for replicating a server. +// The replication parameters for replicating a server. type ServerReplicationParameters struct { _ struct{} `type:"structure"` - // When true, the replication job produces encrypted AMIs. See also KmsKeyId - // below. + // Indicates whether the replication job produces encrypted AMIs. Encrypted *bool `locationName:"encrypted" type:"boolean"` - // Frequency of creating replication jobs for the server. + // The frequency of creating replication jobs for the server. Frequency *int64 `locationName:"frequency" type:"integer"` - // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of - // the following: + // The ID of the KMS key for replication jobs that produce encrypted AMIs. This + // value can be any of the following: // // * KMS key ID // // * KMS key alias // - // * ARN referring to KMS key ID + // * ARN referring to the KMS key ID // - // * ARN referring to KMS key alias + // * ARN referring to the KMS key alias // - // If encrypted is true but a KMS key id is not specified, the customer's default - // KMS key for EBS is used. + // If encrypted is enabled but a KMS key ID is not specified, the customer's + // default KMS key for Amazon EBS is used. KmsKeyId *string `locationName:"kmsKeyId" type:"string"` - // License type for creating a replication job for the server. + // The license type for creating a replication job for the server. LicenseType *string `locationName:"licenseType" type:"string" enum:"LicenseType"` - // Number of recent AMIs to keep when creating a replication job for this server. + // The number of recent AMIs to keep when creating a replication job for this + // server. NumberOfRecentAmisToKeep *int64 `locationName:"numberOfRecentAmisToKeep" type:"integer"` + // Indicates whether to run the replication job one time. RunOnce *bool `locationName:"runOnce" type:"boolean"` - // Seed time for creating a replication job for the server. + // The seed time for creating a replication job for the server. SeedTime *time.Time `locationName:"seedTime" type:"timestamp"` } @@ -5830,10 +7380,151 @@ func (s *ServerReplicationParameters) SetSeedTime(v time.Time) *ServerReplicatio return s } +// Configuration for validating an instance. +type ServerValidationConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the configuration. + Name *string `locationName:"name" min:"1" type:"string"` + + // Represents a server. + Server *Server `locationName:"server" type:"structure"` + + // The validation strategy. + ServerValidationStrategy *string `locationName:"serverValidationStrategy" type:"string" enum:"ServerValidationStrategy"` + + // The validation parameters. + UserDataValidationParameters *UserDataValidationParameters `locationName:"userDataValidationParameters" type:"structure"` + + // The ID of the validation. + ValidationId *string `locationName:"validationId" type:"string"` +} + +// String returns the string representation +func (s ServerValidationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServerValidationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ServerValidationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ServerValidationConfiguration"} + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.UserDataValidationParameters != nil { + if err := s.UserDataValidationParameters.Validate(); err != nil { + invalidParams.AddNested("UserDataValidationParameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *ServerValidationConfiguration) SetName(v string) *ServerValidationConfiguration { + s.Name = &v + return s +} + +// SetServer sets the Server field's value. +func (s *ServerValidationConfiguration) SetServer(v *Server) *ServerValidationConfiguration { + s.Server = v + return s +} + +// SetServerValidationStrategy sets the ServerValidationStrategy field's value. +func (s *ServerValidationConfiguration) SetServerValidationStrategy(v string) *ServerValidationConfiguration { + s.ServerValidationStrategy = &v + return s +} + +// SetUserDataValidationParameters sets the UserDataValidationParameters field's value. +func (s *ServerValidationConfiguration) SetUserDataValidationParameters(v *UserDataValidationParameters) *ServerValidationConfiguration { + s.UserDataValidationParameters = v + return s +} + +// SetValidationId sets the ValidationId field's value. +func (s *ServerValidationConfiguration) SetValidationId(v string) *ServerValidationConfiguration { + s.ValidationId = &v + return s +} + +// Contains output from validating an instance. +type ServerValidationOutput struct { + _ struct{} `type:"structure"` + + // Represents a server. + Server *Server `locationName:"server" type:"structure"` +} + +// String returns the string representation +func (s ServerValidationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServerValidationOutput) GoString() string { + return s.String() +} + +// SetServer sets the Server field's value. +func (s *ServerValidationOutput) SetServer(v *Server) *ServerValidationOutput { + s.Server = v + return s +} + +// Contains the location of a validation script. +type Source struct { + _ struct{} `type:"structure"` + + // Location of an Amazon S3 object. + S3Location *S3Location `locationName:"s3Location" type:"structure"` +} + +// String returns the string representation +func (s Source) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Source) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Source) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Source"} + if s.S3Location != nil { + if err := s.S3Location.Validate(); err != nil { + invalidParams.AddNested("S3Location", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Location sets the S3Location field's value. +func (s *Source) SetS3Location(v *S3Location) *Source { + s.S3Location = v + return s +} + type StartAppReplicationInput struct { _ struct{} `type:"structure"` - // ID of the application to replicate. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -5867,13 +7558,74 @@ func (s StartAppReplicationOutput) GoString() string { return s.String() } +type StartOnDemandAppReplicationInput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + // + // AppId is a required field + AppId *string `locationName:"appId" type:"string" required:"true"` + + // The description of the replication run. + Description *string `locationName:"description" type:"string"` +} + +// String returns the string representation +func (s StartOnDemandAppReplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartOnDemandAppReplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartOnDemandAppReplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartOnDemandAppReplicationInput"} + if s.AppId == nil { + invalidParams.Add(request.NewErrParamRequired("AppId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppId sets the AppId field's value. +func (s *StartOnDemandAppReplicationInput) SetAppId(v string) *StartOnDemandAppReplicationInput { + s.AppId = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *StartOnDemandAppReplicationInput) SetDescription(v string) *StartOnDemandAppReplicationInput { + s.Description = &v + return s +} + +type StartOnDemandAppReplicationOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s StartOnDemandAppReplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartOnDemandAppReplicationOutput) GoString() string { + return s.String() +} + type StartOnDemandReplicationRunInput struct { _ struct{} `type:"structure"` // The description of the replication run. Description *string `locationName:"description" type:"string"` - // The identifier of the replication job. + // The ID of the replication job. // // ReplicationJobId is a required field ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"` @@ -5917,7 +7669,7 @@ func (s *StartOnDemandReplicationRunInput) SetReplicationJobId(v string) *StartO type StartOnDemandReplicationRunOutput struct { _ struct{} `type:"structure"` - // The identifier of the replication run. + // The ID of the replication run. ReplicationRunId *string `locationName:"replicationRunId" type:"string"` } @@ -5940,7 +7692,7 @@ func (s *StartOnDemandReplicationRunOutput) SetReplicationRunId(v string) *Start type StopAppReplicationInput struct { _ struct{} `type:"structure"` - // ID of the application to stop replicating. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -5974,14 +7726,14 @@ func (s StopAppReplicationOutput) GoString() string { return s.String() } -// A label that can be assigned to an application. +// Key/value pair that can be assigned to an application. type Tag struct { _ struct{} `type:"structure"` - // Tag key. + // The tag key. Key *string `locationName:"key" type:"string"` - // Tag value. + // The tag value. Value *string `locationName:"value" type:"string"` } @@ -6066,7 +7818,7 @@ func (s *TemporarilyUnavailableException) RequestID() string { type TerminateAppInput struct { _ struct{} `type:"structure"` - // ID of the application to terminate. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` } @@ -6160,22 +7912,22 @@ func (s *UnauthorizedOperationException) RequestID() string { type UpdateAppInput struct { _ struct{} `type:"structure"` - // ID of the application to update. + // The ID of the application. AppId *string `locationName:"appId" type:"string"` - // New description of the application. + // The new description of the application. Description *string `locationName:"description" type:"string"` - // New name of the application. + // The new name of the application. Name *string `locationName:"name" type:"string"` - // Name of the service role in the customer's account used by AWS SMS. + // The name of the service role in the customer's account used by AWS SMS. RoleName *string `locationName:"roleName" type:"string"` - // List of server groups in the application to update. + // The server groups in the application to update. ServerGroups []*ServerGroup `locationName:"serverGroups" type:"list"` - // List of tags to associate with the application. + // The tags to associate with the application. Tags []*Tag `locationName:"tags" type:"list"` } @@ -6228,13 +7980,13 @@ func (s *UpdateAppInput) SetTags(v []*Tag) *UpdateAppInput { type UpdateAppOutput struct { _ struct{} `type:"structure"` - // Summary description of the application. + // A summary description of the application. AppSummary *AppSummary `locationName:"appSummary" type:"structure"` - // List of updated server groups in the application. + // The updated server groups in the application. ServerGroups []*ServerGroup `locationName:"serverGroups" type:"list"` - // List of tags associated with the application. + // The tags associated with the application. Tags []*Tag `locationName:"tags" type:"list"` } @@ -6272,26 +8024,26 @@ type UpdateReplicationJobInput struct { // The description of the replication job. Description *string `locationName:"description" type:"string"` - // When true, the replication job produces encrypted AMIs . See also KmsKeyId - // below. + // When true, the replication job produces encrypted AMIs. For more information, + // KmsKeyId. Encrypted *bool `locationName:"encrypted" type:"boolean"` // The time between consecutive replication runs, in hours. Frequency *int64 `locationName:"frequency" type:"integer"` - // KMS key ID for replication jobs that produce encrypted AMIs. Can be any of - // the following: + // The ID of the KMS key for replication jobs that produce encrypted AMIs. This + // value can be any of the following: // // * KMS key ID // // * KMS key alias // - // * ARN referring to KMS key ID + // * ARN referring to the KMS key ID // - // * ARN referring to KMS key alias + // * ARN referring to the KMS key alias // - // If encrypted is true but a KMS key id is not specified, the customer's default - // KMS key for EBS is used. + // If encrypted is enabled but a KMS key ID is not specified, the customer's + // default KMS key for Amazon EBS is used. KmsKeyId *string `locationName:"kmsKeyId" type:"string"` // The license type to be used for the AMI created by a successful replication @@ -6301,11 +8053,11 @@ type UpdateReplicationJobInput struct { // The start time of the next replication run. NextReplicationRunStartTime *time.Time `locationName:"nextReplicationRunStartTime" type:"timestamp"` - // The maximum number of SMS-created AMIs to retain. The oldest will be deleted - // once the maximum number is reached and a new AMI is created. + // The maximum number of SMS-created AMIs to retain. The oldest is deleted after + // the maximum number is reached and a new AMI is created. NumberOfRecentAmisToKeep *int64 `locationName:"numberOfRecentAmisToKeep" type:"integer"` - // The identifier of the replication job. + // The ID of the replication job. // // ReplicationJobId is a required field ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"` @@ -6424,12 +8176,153 @@ func (s UserData) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *UserData) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UserData"} + if s.S3Location != nil { + if err := s.S3Location.Validate(); err != nil { + invalidParams.AddNested("S3Location", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetS3Location sets the S3Location field's value. func (s *UserData) SetS3Location(v *S3Location) *UserData { s.S3Location = v return s } +// Contains validation parameters. +type UserDataValidationParameters struct { + _ struct{} `type:"structure"` + + // The type of validation script. + ScriptType *string `locationName:"scriptType" type:"string" enum:"ScriptType"` + + // The location of the validation script. + Source *Source `locationName:"source" type:"structure"` +} + +// String returns the string representation +func (s UserDataValidationParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UserDataValidationParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UserDataValidationParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UserDataValidationParameters"} + if s.Source != nil { + if err := s.Source.Validate(); err != nil { + invalidParams.AddNested("Source", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetScriptType sets the ScriptType field's value. +func (s *UserDataValidationParameters) SetScriptType(v string) *UserDataValidationParameters { + s.ScriptType = &v + return s +} + +// SetSource sets the Source field's value. +func (s *UserDataValidationParameters) SetSource(v *Source) *UserDataValidationParameters { + s.Source = v + return s +} + +// Contains validation output. +type ValidationOutput struct { + _ struct{} `type:"structure"` + + // The output from validating an application. + AppValidationOutput *AppValidationOutput `locationName:"appValidationOutput" type:"structure"` + + // The latest time that the validation was performed. + LatestValidationTime *time.Time `locationName:"latestValidationTime" type:"timestamp"` + + // The name of the validation. + Name *string `locationName:"name" min:"1" type:"string"` + + // The output from validation an instance. + ServerValidationOutput *ServerValidationOutput `locationName:"serverValidationOutput" type:"structure"` + + // The status of the validation. + Status *string `locationName:"status" type:"string" enum:"ValidationStatus"` + + // The status message. + StatusMessage *string `locationName:"statusMessage" type:"string"` + + // The ID of the validation. + ValidationId *string `locationName:"validationId" type:"string"` +} + +// String returns the string representation +func (s ValidationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ValidationOutput) GoString() string { + return s.String() +} + +// SetAppValidationOutput sets the AppValidationOutput field's value. +func (s *ValidationOutput) SetAppValidationOutput(v *AppValidationOutput) *ValidationOutput { + s.AppValidationOutput = v + return s +} + +// SetLatestValidationTime sets the LatestValidationTime field's value. +func (s *ValidationOutput) SetLatestValidationTime(v time.Time) *ValidationOutput { + s.LatestValidationTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *ValidationOutput) SetName(v string) *ValidationOutput { + s.Name = &v + return s +} + +// SetServerValidationOutput sets the ServerValidationOutput field's value. +func (s *ValidationOutput) SetServerValidationOutput(v *ServerValidationOutput) *ValidationOutput { + s.ServerValidationOutput = v + return s +} + +// SetStatus sets the Status field's value. +func (s *ValidationOutput) SetStatus(v string) *ValidationOutput { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *ValidationOutput) SetStatusMessage(v string) *ValidationOutput { + s.StatusMessage = &v + return s +} + +// SetValidationId sets the ValidationId field's value. +func (s *ValidationOutput) SetValidationId(v string) *ValidationOutput { + s.ValidationId = &v + return s +} + // Represents a VM server. type VmServer struct { _ struct{} `type:"structure"` @@ -6446,7 +8339,7 @@ type VmServer struct { // The VM folder path in the vCenter Server virtual machine inventory tree. VmPath *string `locationName:"vmPath" type:"string"` - // Information about the VM server location. + // The VM server location. VmServerAddress *VmServerAddress `locationName:"vmServerAddress" type:"structure"` } @@ -6494,10 +8387,10 @@ func (s *VmServer) SetVmServerAddress(v *VmServerAddress) *VmServer { type VmServerAddress struct { _ struct{} `type:"structure"` - // The identifier of the VM. + // The ID of the VM. VmId *string `locationName:"vmId" type:"string"` - // The identifier of the VM manager. + // The ID of the VM manager. VmManagerId *string `locationName:"vmManagerId" type:"string"` } @@ -6523,6 +8416,14 @@ func (s *VmServerAddress) SetVmManagerId(v string) *VmServerAddress { return s } +const ( + // AppLaunchConfigurationStatusNotConfigured is a AppLaunchConfigurationStatus enum value + AppLaunchConfigurationStatusNotConfigured = "NOT_CONFIGURED" + + // AppLaunchConfigurationStatusConfigured is a AppLaunchConfigurationStatus enum value + AppLaunchConfigurationStatusConfigured = "CONFIGURED" +) + const ( // AppLaunchStatusReadyForConfiguration is a AppLaunchStatus enum value AppLaunchStatusReadyForConfiguration = "READY_FOR_CONFIGURATION" @@ -6548,6 +8449,9 @@ const ( // AppLaunchStatusLaunched is a AppLaunchStatus enum value AppLaunchStatusLaunched = "LAUNCHED" + // AppLaunchStatusPartiallyLaunched is a AppLaunchStatus enum value + AppLaunchStatusPartiallyLaunched = "PARTIALLY_LAUNCHED" + // AppLaunchStatusDeltaLaunchInProgress is a AppLaunchStatus enum value AppLaunchStatusDeltaLaunchInProgress = "DELTA_LAUNCH_IN_PROGRESS" @@ -6567,6 +8471,14 @@ const ( AppLaunchStatusTerminated = "TERMINATED" ) +const ( + // AppReplicationConfigurationStatusNotConfigured is a AppReplicationConfigurationStatus enum value + AppReplicationConfigurationStatusNotConfigured = "NOT_CONFIGURED" + + // AppReplicationConfigurationStatusConfigured is a AppReplicationConfigurationStatus enum value + AppReplicationConfigurationStatusConfigured = "CONFIGURED" +) + const ( // AppReplicationStatusReadyForConfiguration is a AppReplicationStatus enum value AppReplicationStatusReadyForConfiguration = "READY_FOR_CONFIGURATION" @@ -6592,6 +8504,9 @@ const ( // AppReplicationStatusReplicated is a AppReplicationStatus enum value AppReplicationStatusReplicated = "REPLICATED" + // AppReplicationStatusPartiallyReplicated is a AppReplicationStatus enum value + AppReplicationStatusPartiallyReplicated = "PARTIALLY_REPLICATED" + // AppReplicationStatusDeltaReplicationInProgress is a AppReplicationStatus enum value AppReplicationStatusDeltaReplicationInProgress = "DELTA_REPLICATION_IN_PROGRESS" @@ -6634,6 +8549,11 @@ const ( AppStatusDeleteFailed = "DELETE_FAILED" ) +const ( + // AppValidationStrategySsm is a AppValidationStrategy enum value + AppValidationStrategySsm = "SSM" +) + const ( // ConnectorCapabilityVsphere is a ConnectorCapability enum value ConnectorCapabilityVsphere = "VSPHERE" @@ -6646,6 +8566,9 @@ const ( // ConnectorCapabilitySnapshotBatching is a ConnectorCapability enum value ConnectorCapabilitySnapshotBatching = "SNAPSHOT_BATCHING" + + // ConnectorCapabilitySmsOptimized is a ConnectorCapability enum value + ConnectorCapabilitySmsOptimized = "SMS_OPTIMIZED" ) const ( @@ -6729,6 +8652,14 @@ const ( ReplicationRunTypeAutomatic = "AUTOMATIC" ) +const ( + // ScriptTypeShellScript is a ScriptType enum value + ScriptTypeShellScript = "SHELL_SCRIPT" + + // ScriptTypePowershellScript is a ScriptType enum value + ScriptTypePowershellScript = "POWERSHELL_SCRIPT" +) + const ( // ServerCatalogStatusNotImported is a ServerCatalogStatus enum value ServerCatalogStatusNotImported = "NOT_IMPORTED" @@ -6751,6 +8682,28 @@ const ( ServerTypeVirtualMachine = "VIRTUAL_MACHINE" ) +const ( + // ServerValidationStrategyUserdata is a ServerValidationStrategy enum value + ServerValidationStrategyUserdata = "USERDATA" +) + +const ( + // ValidationStatusReadyForValidation is a ValidationStatus enum value + ValidationStatusReadyForValidation = "READY_FOR_VALIDATION" + + // ValidationStatusPending is a ValidationStatus enum value + ValidationStatusPending = "PENDING" + + // ValidationStatusInProgress is a ValidationStatus enum value + ValidationStatusInProgress = "IN_PROGRESS" + + // ValidationStatusSucceeded is a ValidationStatus enum value + ValidationStatusSucceeded = "SUCCEEDED" + + // ValidationStatusFailed is a ValidationStatus enum value + ValidationStatusFailed = "FAILED" +) + const ( // VmManagerTypeVsphere is a VmManagerType enum value VmManagerTypeVsphere = "VSPHERE" diff --git a/service/sms/doc.go b/service/sms/doc.go index 4b429cf67e8..dedb9d07850 100644 --- a/service/sms/doc.go +++ b/service/sms/doc.go @@ -3,21 +3,13 @@ // Package sms provides the client and types for making API // requests to AWS Server Migration Service. // -// This is the AWS Sever Migration Service API Reference. It provides descriptions, -// syntax, and usage examples for each of the actions and data types for the -// AWS Sever Migration Service (AWS SMS). The topic for each action shows the -// Query API request parameters and the XML response. You can also view the -// XML request elements in the WSDL. +// AWS Server Migration Service (AWS SMS) makes it easier and faster for you +// to migrate your on-premises workloads to AWS. To learn more about AWS SMS, +// see the following resources: // -// Alternatively, you can use one of the AWS SDKs to access an API that's tailored -// to the programming language or platform that you're using. For more information, -// see AWS SDKs (http://aws.amazon.com/tools/#SDKs). +// * AWS Server Migration Service product page (http://aws.amazon.com/server-migration-service/) // -// To learn more about the Server Migration Service, see the following resources: -// -// * AWS Sever Migration Service product page (https://aws.amazon.com/server-migration-service/) -// -// * AWS Sever Migration Service User Guide (https://docs.aws.amazon.com/server-migration-service/latest/userguide/server-migration.html) +// * AWS Server Migration Service User Guide (https://docs.aws.amazon.com/server-migration-service/latest/userguide/) // // See https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24 for more information on this service. // diff --git a/service/sms/errors.go b/service/sms/errors.go index f9cf24b55af..27e38278552 100644 --- a/service/sms/errors.go +++ b/service/sms/errors.go @@ -8,6 +8,13 @@ import ( const ( + // ErrCodeDryRunOperationException for service response error code + // "DryRunOperationException". + // + // The user has the required permissions, so the request would have succeeded, + // but a dry run was performed. + ErrCodeDryRunOperationException = "DryRunOperationException" + // ErrCodeInternalError for service response error code // "InternalError". // @@ -78,6 +85,7 @@ const ( ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "DryRunOperationException": newErrorDryRunOperationException, "InternalError": newErrorInternalError, "InvalidParameterException": newErrorInvalidParameterException, "MissingRequiredParameterException": newErrorMissingRequiredParameterException, diff --git a/service/sms/smsiface/interface.go b/service/sms/smsiface/interface.go index fffe227e01b..f0edca82fa9 100644 --- a/service/sms/smsiface/interface.go +++ b/service/sms/smsiface/interface.go @@ -80,6 +80,10 @@ type SMSAPI interface { DeleteAppReplicationConfigurationWithContext(aws.Context, *sms.DeleteAppReplicationConfigurationInput, ...request.Option) (*sms.DeleteAppReplicationConfigurationOutput, error) DeleteAppReplicationConfigurationRequest(*sms.DeleteAppReplicationConfigurationInput) (*request.Request, *sms.DeleteAppReplicationConfigurationOutput) + DeleteAppValidationConfiguration(*sms.DeleteAppValidationConfigurationInput) (*sms.DeleteAppValidationConfigurationOutput, error) + DeleteAppValidationConfigurationWithContext(aws.Context, *sms.DeleteAppValidationConfigurationInput, ...request.Option) (*sms.DeleteAppValidationConfigurationOutput, error) + DeleteAppValidationConfigurationRequest(*sms.DeleteAppValidationConfigurationInput) (*request.Request, *sms.DeleteAppValidationConfigurationOutput) + DeleteReplicationJob(*sms.DeleteReplicationJobInput) (*sms.DeleteReplicationJobOutput, error) DeleteReplicationJobWithContext(aws.Context, *sms.DeleteReplicationJobInput, ...request.Option) (*sms.DeleteReplicationJobOutput, error) DeleteReplicationJobRequest(*sms.DeleteReplicationJobInput) (*request.Request, *sms.DeleteReplicationJobOutput) @@ -112,6 +116,14 @@ type SMSAPI interface { GetAppReplicationConfigurationWithContext(aws.Context, *sms.GetAppReplicationConfigurationInput, ...request.Option) (*sms.GetAppReplicationConfigurationOutput, error) GetAppReplicationConfigurationRequest(*sms.GetAppReplicationConfigurationInput) (*request.Request, *sms.GetAppReplicationConfigurationOutput) + GetAppValidationConfiguration(*sms.GetAppValidationConfigurationInput) (*sms.GetAppValidationConfigurationOutput, error) + GetAppValidationConfigurationWithContext(aws.Context, *sms.GetAppValidationConfigurationInput, ...request.Option) (*sms.GetAppValidationConfigurationOutput, error) + GetAppValidationConfigurationRequest(*sms.GetAppValidationConfigurationInput) (*request.Request, *sms.GetAppValidationConfigurationOutput) + + GetAppValidationOutput(*sms.GetAppValidationOutputInput) (*sms.GetAppValidationOutputOutput, error) + GetAppValidationOutputWithContext(aws.Context, *sms.GetAppValidationOutputInput, ...request.Option) (*sms.GetAppValidationOutputOutput, error) + GetAppValidationOutputRequest(*sms.GetAppValidationOutputInput) (*request.Request, *sms.GetAppValidationOutputOutput) + GetConnectors(*sms.GetConnectorsInput) (*sms.GetConnectorsOutput, error) GetConnectorsWithContext(aws.Context, *sms.GetConnectorsInput, ...request.Option) (*sms.GetConnectorsOutput, error) GetConnectorsRequest(*sms.GetConnectorsInput) (*request.Request, *sms.GetConnectorsOutput) @@ -140,6 +152,10 @@ type SMSAPI interface { GetServersPages(*sms.GetServersInput, func(*sms.GetServersOutput, bool) bool) error GetServersPagesWithContext(aws.Context, *sms.GetServersInput, func(*sms.GetServersOutput, bool) bool, ...request.Option) error + ImportAppCatalog(*sms.ImportAppCatalogInput) (*sms.ImportAppCatalogOutput, error) + ImportAppCatalogWithContext(aws.Context, *sms.ImportAppCatalogInput, ...request.Option) (*sms.ImportAppCatalogOutput, error) + ImportAppCatalogRequest(*sms.ImportAppCatalogInput) (*request.Request, *sms.ImportAppCatalogOutput) + ImportServerCatalog(*sms.ImportServerCatalogInput) (*sms.ImportServerCatalogOutput, error) ImportServerCatalogWithContext(aws.Context, *sms.ImportServerCatalogInput, ...request.Option) (*sms.ImportServerCatalogOutput, error) ImportServerCatalogRequest(*sms.ImportServerCatalogInput) (*request.Request, *sms.ImportServerCatalogOutput) @@ -152,6 +168,10 @@ type SMSAPI interface { ListAppsWithContext(aws.Context, *sms.ListAppsInput, ...request.Option) (*sms.ListAppsOutput, error) ListAppsRequest(*sms.ListAppsInput) (*request.Request, *sms.ListAppsOutput) + NotifyAppValidationOutput(*sms.NotifyAppValidationOutputInput) (*sms.NotifyAppValidationOutputOutput, error) + NotifyAppValidationOutputWithContext(aws.Context, *sms.NotifyAppValidationOutputInput, ...request.Option) (*sms.NotifyAppValidationOutputOutput, error) + NotifyAppValidationOutputRequest(*sms.NotifyAppValidationOutputInput) (*request.Request, *sms.NotifyAppValidationOutputOutput) + PutAppLaunchConfiguration(*sms.PutAppLaunchConfigurationInput) (*sms.PutAppLaunchConfigurationOutput, error) PutAppLaunchConfigurationWithContext(aws.Context, *sms.PutAppLaunchConfigurationInput, ...request.Option) (*sms.PutAppLaunchConfigurationOutput, error) PutAppLaunchConfigurationRequest(*sms.PutAppLaunchConfigurationInput) (*request.Request, *sms.PutAppLaunchConfigurationOutput) @@ -160,10 +180,18 @@ type SMSAPI interface { PutAppReplicationConfigurationWithContext(aws.Context, *sms.PutAppReplicationConfigurationInput, ...request.Option) (*sms.PutAppReplicationConfigurationOutput, error) PutAppReplicationConfigurationRequest(*sms.PutAppReplicationConfigurationInput) (*request.Request, *sms.PutAppReplicationConfigurationOutput) + PutAppValidationConfiguration(*sms.PutAppValidationConfigurationInput) (*sms.PutAppValidationConfigurationOutput, error) + PutAppValidationConfigurationWithContext(aws.Context, *sms.PutAppValidationConfigurationInput, ...request.Option) (*sms.PutAppValidationConfigurationOutput, error) + PutAppValidationConfigurationRequest(*sms.PutAppValidationConfigurationInput) (*request.Request, *sms.PutAppValidationConfigurationOutput) + StartAppReplication(*sms.StartAppReplicationInput) (*sms.StartAppReplicationOutput, error) StartAppReplicationWithContext(aws.Context, *sms.StartAppReplicationInput, ...request.Option) (*sms.StartAppReplicationOutput, error) StartAppReplicationRequest(*sms.StartAppReplicationInput) (*request.Request, *sms.StartAppReplicationOutput) + StartOnDemandAppReplication(*sms.StartOnDemandAppReplicationInput) (*sms.StartOnDemandAppReplicationOutput, error) + StartOnDemandAppReplicationWithContext(aws.Context, *sms.StartOnDemandAppReplicationInput, ...request.Option) (*sms.StartOnDemandAppReplicationOutput, error) + StartOnDemandAppReplicationRequest(*sms.StartOnDemandAppReplicationInput) (*request.Request, *sms.StartOnDemandAppReplicationOutput) + StartOnDemandReplicationRun(*sms.StartOnDemandReplicationRunInput) (*sms.StartOnDemandReplicationRunOutput, error) StartOnDemandReplicationRunWithContext(aws.Context, *sms.StartOnDemandReplicationRunInput, ...request.Option) (*sms.StartOnDemandReplicationRunOutput, error) StartOnDemandReplicationRunRequest(*sms.StartOnDemandReplicationRunInput) (*request.Request, *sms.StartOnDemandReplicationRunOutput)