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',
    'ManagedSecretConfig': {
        'SecretArn': 'string'
    },
    'CmkSecretConfig': {
        'SecretArn': 'string',
        'KmsKeyArn': 'string'
    },
    'CustomSecretConfig': {
        'SecretArn': 'string',
        'SecretAccessRoleArn': 'string'
    }
}

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).

    • ManagedSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

    • CmkSecretConfig (dict) –

      Describes configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

      • SecretArn (string) –

        Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.

      • KmsKeyArn (string) –

        Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.

    • CustomSecretConfig (dict) –

      Describes configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

      • SecretArn (string) –

        Specifies the ARN for an Secrets Manager secret.

      • SecretAccessRoleArn (string) –

        Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.

Exceptions