AWS DataSync

{'AgentArns': ['string'], 'S3StorageClass': {'OUTPOSTS'}}

Creates an endpoint for an Amazon S3 bucket.

For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli in the AWS DataSync User Guide .

See also: AWS API Documentation

Request Syntax

client.create_location_s3(
    Subdirectory='string',
    S3BucketArn='string',
    S3StorageClass='STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS',
    S3Config={
        'BucketAccessRoleArn': 'string'
    },
    AgentArns=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Subdirectory

string

param Subdirectory

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

type S3BucketArn

string

param S3BucketArn

[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon S3 bucket. If the bucket is on an AWS Outpost, this must be an access point ARN.

type S3StorageClass

string

param S3StorageClass

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes in the Amazon Simple Storage Service Developer Guide . Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

type S3Config

dict

param S3Config

[REQUIRED]

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

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

• BucketAccessRoleArn (string) -- [REQUIRED]

  The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.

type AgentArns

list

param AgentArns

If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your AWS Outpost. For more information about launching a DataSync agent on an Amazon Outpost, see outposts-agent.

• (string) --

type Tags

list

param Tags

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

• (dict) --

  Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

  • Key (string) -- [REQUIRED]

    The key for an AWS resource tag.

  • Value (string) --

    The value for an AWS resource tag.

rtype

dict

returns

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

• (dict) --

  CreateLocationS3Response

  • LocationArn (string) --

    The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

{'AgentArns': ['string'], 'S3StorageClass': {'OUTPOSTS'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_location_s3(
    LocationArn='string'
)

type LocationArn

string

param LocationArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'S3StorageClass': 'STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS',
    '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 in the Amazon Simple Storage Service Developer Guide . Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

  • S3Config (dict) --

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

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

    • BucketAccessRoleArn (string) --

      The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.

  • AgentArns (list) --

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

    • (string) --

  • CreationTime (datetime) --

    The time that the Amazon S3 bucket location was created.