DataSync / Client / update_location_s3

update_location_s3#

DataSync.Client.update_location_s3(**kwargs)#

Modifies the following configuration parameters of the Amazon S3 transfer location that you’re using with DataSync.

Warning

Before you begin, make sure that you read the following topics:

See also: AWS API Documentation

Request Syntax

response = client.update_location_s3(
    LocationArn='string',
    Subdirectory='string',
    S3StorageClass='STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_INSTANT_RETRIEVAL',
    S3Config={
        'BucketAccessRoleArn': 'string'
    }
)
Parameters:

  • LocationArn (string) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you’re updating.

  • Subdirectory (string) –

    Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).

    Note

    DataSync can’t transfer objects with a prefix that begins with a slash ( /) or includes //, /./, or /../ patterns. For example:

    • /photos

    • photos//2006/January

    • photos/./2006/February

    • photos/../2006/March

  • S3StorageClass (string) –

    Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

    For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

    For more information, see Storage class considerations with Amazon S3 transfers.

  • S3Config (dict) –

    Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.

    For more information, see Providing DataSync access to S3 buckets.

    • BucketAccessRoleArn (string) – [REQUIRED]

      Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException