DataSync / Client / describe_location_object_storage

describe_location_object_storage#

DataSync.Client.describe_location_object_storage(**kwargs)#

Provides details about how an DataSync transfer location for an object storage system is configured.

See also: AWS API Documentation

Request Syntax

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

LocationArn (string) –

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the object storage system location.

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 URI 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 connect with your object storage system.

      • (string) –

    • CreationTime (datetime) –

      The time that the location was created.

    • ServerCertificate (bytes) –

      The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

Exceptions