Lightsail / Client / get_relational_database_snapshots

get_relational_database_snapshots#

Lightsail.Client.get_relational_database_snapshots(**kwargs)#

Returns information about all of your database snapshots in Amazon Lightsail.

Request Syntax

response = client.get_relational_database_snapshots(
    pageToken='string'
)

Parameters:

pageToken (string) –

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Return type:

dict

Returns:

Response Syntax

{
    'relationalDatabaseSnapshots': [
        {
            'name': 'string',
            'arn': 'string',
            'supportCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'engine': 'string',
            'engineVersion': 'string',
            'sizeInGb': 123,
            'state': 'string',
            'fromRelationalDatabaseName': 'string',
            'fromRelationalDatabaseArn': 'string',
            'fromRelationalDatabaseBundleId': 'string',
            'fromRelationalDatabaseBlueprintId': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- relationalDatabaseSnapshots (list) –
  
  An object describing the result of your get relational database snapshots request.
  - (dict) –
    
    Describes a database snapshot.
    - name (string) –
      
      The name of the database snapshot.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the database snapshot.
    - supportCode (string) –
      
      The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
    - createdAt (datetime) –
      
      The timestamp when the database snapshot was created.
    - location (dict) –
      
      The Region name and Availability Zone where the database snapshot is located.
      - availabilityZone (string) –
        
        The Availability Zone. Follows the format us-east-2a (case-sensitive).
      - regionName (string) –
        
        The Amazon Web Services Region name.
    - resourceType (string) –
      
      The Lightsail resource type.
    - tags (list) –
      
      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      - (dict) –
        
        Describes a tag key and optional value assigned to an Amazon Lightsail resource.
        
        For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
        
        key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
        
        value (string) –
        
        The value of the tag.
        
        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
    - engine (string) –
      
      The software of the database snapshot (for example, MySQL)
    - engineVersion (string) –
      
      The database engine version for the database snapshot (for example, 5.7.23).
    - sizeInGb (integer) –
      
      The size of the disk in GB (for example, 32) for the database snapshot.
    - state (string) –
      
      The state of the database snapshot.
    - fromRelationalDatabaseName (string) –
      
      The name of the source database from which the database snapshot was created.
    - fromRelationalDatabaseArn (string) –
      
      The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
    - fromRelationalDatabaseBundleId (string) –
      
      The bundle ID of the database from which the database snapshot was created.
    - fromRelationalDatabaseBlueprintId (string) –
      
      The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- nextPageToken (string) –
  
  The token to advance to the next page of results from your request.
  
  A next page token is not returned if there are no more results to display.
  
  To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.

Exceptions

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.OperationFailureException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.AccountSetupInProgressException
Lightsail.Client.exceptions.UnauthenticatedException