:doc:`KinesisAnalyticsV2 <../../kinesisanalyticsv2>` / Client / describe_application_snapshot

*****************************
describe_application_snapshot
*****************************



.. py:method:: KinesisAnalyticsV2.Client.describe_application_snapshot(**kwargs)

  

  Returns information about a snapshot of application state data.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationSnapshot>`_  


  **Request Syntax**
  ::

    response = client.describe_application_snapshot(
        ApplicationName='string',
        SnapshotName='string'
    )
    
  :type ApplicationName: string
  :param ApplicationName: **[REQUIRED]** 

    The name of an existing application.

    

  
  :type SnapshotName: string
  :param SnapshotName: **[REQUIRED]** 

    The identifier of an application snapshot. You can retrieve this value using .

    

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

    
    ::

      {
          'SnapshotDetails': {
              'SnapshotName': 'string',
              'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
              'ApplicationVersionId': 123,
              'SnapshotCreationTimestamp': datetime(2015, 1, 1),
              'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20',
              'ApplicationEncryptionConfigurationDescription': {
                  'KeyId': 'string',
                  'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SnapshotDetails** *(dict) --* 

        An object containing information about the application snapshot.

        
        

        - **SnapshotName** *(string) --* 

          The identifier for the application snapshot.

          
        

        - **SnapshotStatus** *(string) --* 

          The status of the application snapshot.

          
        

        - **ApplicationVersionId** *(integer) --* 

          The current application version ID when the snapshot was created.

          
        

        - **SnapshotCreationTimestamp** *(datetime) --* 

          The timestamp of the application snapshot.

          
        

        - **RuntimeEnvironment** *(string) --* 

          The Flink Runtime for the application snapshot.

          
        

        - **ApplicationEncryptionConfigurationDescription** *(dict) --* 

          Specifies the encryption settings of data at rest for the application snapshot.

          
          

          - **KeyId** *(string) --* 

            The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.

            
          

          - **KeyType** *(string) --* 

            Specifies the type of key used for encryption at rest.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`KinesisAnalyticsV2.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`KinesisAnalyticsV2.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`KinesisAnalyticsV2.Client.exceptions.UnsupportedOperationException`

  