[ aws . datasync ]

describe-location-s3

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-location-s3
--location-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--location-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

LocationArn -> (string)

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

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 -> (structure)

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.

CreationTime -> (timestamp)

The time that the Amazon S3 bucket location was created.