DescribeLocationS3Command

Suggest an Edit

Provides details about how an DataSync transfer location for an S3 bucket is configured.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, DescribeLocationS3Command } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationS3Command } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationS3Request
  LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationS3Command(input);
const response = await client.send(command);
// { // DescribeLocationS3Response
//   LocationArn: "STRING_VALUE",
//   LocationUri: "STRING_VALUE",
//   S3StorageClass: "STANDARD" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_INSTANT_RETRIEVAL",
//   S3Config: { // S3Config
//     BucketAccessRoleArn: "STRING_VALUE", // required
//   },
//   AgentArns: [ // AgentArnList
//     "STRING_VALUE",
//   ],
//   CreationTime: new Date("TIMESTAMP"),
// };

DescribeLocationS3Command Input

See DescribeLocationS3CommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.

DescribeLocationS3Command Output

See DescribeLocationS3CommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AgentArns
string[] | undefined

The ARNs of the DataSync agents deployed on your Outpost when using working with Amazon S3 on Outposts.

For more information, see Deploy your DataSync agent on Outposts .

CreationTime
Date | undefined

The time that the Amazon S3 location was created.

LocationArn
string | undefined

The ARN of the Amazon S3 location.

LocationUri
string | undefined

The URL of the Amazon S3 location that was described.

S3Config
S3Config | undefined

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 .

S3StorageClass
S3StorageClass | undefined

When Amazon S3 is a destination location, this is the storage class that you chose for your objects.

Some storage classes have behaviors that can affect your Amazon S3 storage costs. For more information, see Storage class considerations with Amazon S3 transfers .

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.