:doc:`Lightsail <../../lightsail>` / Client / get_relational_database_snapshot

********************************
get_relational_database_snapshot
********************************



.. py:method:: Lightsail.Client.get_relational_database_snapshot(**kwargs)

  

  Returns information about a specific database snapshot in Amazon Lightsail.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshot>`_  


  **Request Syntax**
  ::

    response = client.get_relational_database_snapshot(
        relationalDatabaseSnapshotName='string'
    )
    
  :type relationalDatabaseSnapshotName: string
  :param relationalDatabaseSnapshotName: **[REQUIRED]** 

    The name of the database snapshot for which to get information.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'relationalDatabaseSnapshot': {
              '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'|'ap-southeast-3'
              },
              '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'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **relationalDatabaseSnapshot** *(dict) --* 

        An object describing the specified 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 <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags>`__.

          
          

          - *(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 <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags>`__.

            
            

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

          
    
  
  **Exceptions**
  
  *   :py:class:`Lightsail.Client.exceptions.ServiceException`

  
  *   :py:class:`Lightsail.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Lightsail.Client.exceptions.NotFoundException`

  
  *   :py:class:`Lightsail.Client.exceptions.OperationFailureException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccountSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.RegionSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.UnauthenticatedException`

  