odb / Client / stop_autonomous_database

stop_autonomous_database

odb.Client.stop_autonomous_database(**kwargs)

Stops the specified Autonomous Database.

See also: AWS API Documentation

Request Syntax

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

autonomousDatabaseId (string) –

[REQUIRED]

The unique identifier of the Autonomous Database to stop.

Return type:

dict

Returns:

Response Syntax

{
    'autonomousDatabaseId': 'string',
    'displayName': 'string',
    'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS'|'STOPPING'|'STOPPED'|'STARTING'|'UNAVAILABLE'|'RESTORE_IN_PROGRESS'|'RESTORE_FAILED'|'BACKUP_IN_PROGRESS'|'SCALE_IN_PROGRESS'|'AVAILABLE_NEEDS_ATTENTION'|'RESTARTING'|'RECREATING'|'ROLE_CHANGE_IN_PROGRESS'|'UPGRADING'|'INACCESSIBLE'|'STANDBY',
    'statusReason': 'string'
}

Response Structure

  • (dict) –

    • autonomousDatabaseId (string) –

      The unique identifier of the Autonomous Database that was stopped.

    • displayName (string) –

      The user-friendly name of the Autonomous Database.

    • status (string) –

      The current status of the Autonomous Database after the stop operation.

    • statusReason (string) –

      Additional information about the status of the Autonomous Database after the stop operation.

Exceptions

  • odb.Client.exceptions.ThrottlingException

  • odb.Client.exceptions.ValidationException

  • odb.Client.exceptions.ConflictException

  • odb.Client.exceptions.AccessDeniedException

  • odb.Client.exceptions.InternalServerException

  • odb.Client.exceptions.ResourceNotFoundException