describe_location_s3

DataSync.Client.describe_location_s3(**kwargs)

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_s3(
    LocationArn='string'
)

Parameters

LocationArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

Return type

dict

Returns

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'S3StorageClass': 'STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_INSTANT_RETRIEVAL',
    'S3Config': {
        'BucketAccessRoleArn': 'string'
    },
    'AgentArns': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  DescribeLocationS3Response

  • LocationArn (string) --

    The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

  • LocationUri (string) --

    The URL of the Amazon S3 location that was described.

  • S3StorageClass (string) --

    The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

  • S3Config (dict) --

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.

    For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide .

    • BucketAccessRoleArn (string) --

      The ARN of the IAM role for accessing the S3 bucket.

  • AgentArns (list) --

    If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

    • (string) --
  • CreationTime (datetime) --

    The time that the Amazon S3 bucket location was created.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException
• DataSync.Client.exceptions.InternalException