odb / Client / get_autonomous_database_wallet_details

get_autonomous_database_wallet_details

odb.Client.get_autonomous_database_wallet_details(**kwargs)

Gets the wallet details for the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

response = client.get_autonomous_database_wallet_details(
    autonomousDatabaseId='string'
)
Parameters:

autonomousDatabaseId (string) –

[REQUIRED]

The unique identifier of the Autonomous Database to retrieve wallet details for.

Return type:

dict

Returns:

Response Syntax

{
    'autonomousDatabaseWalletDetails': {
        'status': 'ACTIVE'|'UPDATING',
        'timeRotated': datetime(2015, 1, 1),
        'passwordSourceSummary': {
            'passwordSource': 'CUSTOMER_MANAGED_AWS_SECRET'|'API_REQUEST_PARAMETER',
            'passwordSourceConfiguration': {
                'customerManagedAwsSecret': {
                    'iamRoleArn': 'string',
                    'secretId': 'string',
                    'externalIdType': 'database_ocid'|'compartment_ocid'|'tenant_ocid'
                }
            }
        }
    }
}

Response Structure

  • (dict) –

    • autonomousDatabaseWalletDetails (dict) –

      The wallet details for the Autonomous Database.

      • status (string) –

        The current status of the Autonomous Database wallet.

      • timeRotated (datetime) –

        The date and time when the Autonomous Database wallet was last rotated.

      • passwordSourceSummary (dict) –

        The summary of the password source configuration for the Autonomous Database wallet.

        • passwordSource (string) –

          The source of the password for the Autonomous Database wallet.

        • passwordSourceConfiguration (dict) –

          The configuration of the password source for the Autonomous Database wallet.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: customerManagedAwsSecret. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • customerManagedAwsSecret (dict) –

            The configuration for a customer-managed Amazon Web Services Secrets Manager secret used as the wallet password source.

            • iamRoleArn (string) –

              The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that OCI assumes to retrieve the secret value.

            • secretId (string) –

              The identifier or ARN of the Amazon Web Services Secrets Manager secret that contains the password.

            • externalIdType (string) –

              The type of Oracle Cloud Identifier (OCID) used as the external ID when assuming the IAM role.

Exceptions