Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_location_object_storage

describe_location_object_storage(**kwargs)

Returns metadata about your DataSync location for an object storage system.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_object_storage(
    LocationArn='string'
)
Parameters
LocationArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the object storage system location that you want information about.

Return type
dict
Returns
Response Syntax
{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'AccessKey': 'string',
    'ServerPort': 123,
    'ServerProtocol': 'HTTPS'|'HTTP',
    'AgentArns': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1),
    'ServerCertificate': b'bytes'
}

Response Structure

  • (dict) --

    DescribeLocationObjectStorageResponse

    • LocationArn (string) --

      The ARN of the object storage system location.

    • LocationUri (string) --

      The URL of the object storage system location.

    • AccessKey (string) --

      The access key (for example, a user name) required to authenticate with the object storage system.

    • ServerPort (integer) --

      The port that your object storage server accepts inbound network traffic on (for example, port 443).

    • ServerProtocol (string) --

      The protocol that your object storage system uses to communicate.

    • AgentArns (list) --

      The ARNs of the DataSync agents that can securely connect with your location.

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

      The time that the location was created.

    • ServerCertificate (bytes) --

      The self-signed certificate that DataSync uses to securely authenticate with your object storage system.

Exceptions

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