:doc:`drs <../../drs>` / Client / describe_source_networks

************************
describe_source_networks
************************



.. py:method:: drs.Client.describe_source_networks(**kwargs)

  

  Lists all Source Networks or multiple Source Networks filtered by ID.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeSourceNetworks>`_  


  **Request Syntax**
  ::

    response = client.describe_source_networks(
        filters={
            'originAccountID': 'string',
            'originRegion': 'string',
            'sourceNetworkIDs': [
                'string',
            ]
        },
        maxResults=123,
        nextToken='string'
    )
    
  :type filters: dict
  :param filters: 

    A set of filters by which to return Source Networks.

    

  
    - **originAccountID** *(string) --* 

      Filter Source Networks by account ID containing the protected VPCs.

      

    
    - **originRegion** *(string) --* 

      Filter Source Networks by the region containing the protected VPCs.

      

    
    - **sourceNetworkIDs** *(list) --* 

      An array of Source Network IDs that should be returned. An empty array means all Source Networks.

      

    
      - *(string) --* 

      
  
  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of Source Networks to retrieve.

    

  
  :type nextToken: string
  :param nextToken: 

    The token of the next Source Networks to retrieve.

    

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

    
    ::

      {
          'items': [
              {
                  'arn': 'string',
                  'cfnStackName': 'string',
                  'lastRecovery': {
                      'apiCallDateTime': datetime(2015, 1, 1),
                      'jobID': 'string',
                      'lastRecoveryResult': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCESS'|'FAIL'|'PARTIAL_SUCCESS'|'ASSOCIATE_SUCCESS'|'ASSOCIATE_FAIL'
                  },
                  'launchedVpcID': 'string',
                  'replicationStatus': 'STOPPED'|'IN_PROGRESS'|'PROTECTED'|'ERROR',
                  'replicationStatusDetails': 'string',
                  'sourceAccountID': 'string',
                  'sourceNetworkID': 'string',
                  'sourceRegion': 'string',
                  'sourceVpcID': 'string',
                  'tags': {
                      'string': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **items** *(list) --* 

        An array of Source Networks.

        
        

        - *(dict) --* 

          The ARN of the Source Network.

          
          

          - **arn** *(string) --* 

            The ARN of the Source Network.

            
          

          - **cfnStackName** *(string) --* 

            CloudFormation stack name that was deployed for recovering the Source Network.

            
          

          - **lastRecovery** *(dict) --* 

            An object containing information regarding the last recovery of the Source Network.

            
            

            - **apiCallDateTime** *(datetime) --* 

              The date and time the last Source Network recovery was initiated.

              
            

            - **jobID** *(string) --* 

              The ID of the Job that was used to last recover the Source Network.

              
            

            - **lastRecoveryResult** *(string) --* 

              The status of the last recovery status of this Source Network.

              
        
          

          - **launchedVpcID** *(string) --* 

            ID of the recovered VPC following Source Network recovery.

            
          

          - **replicationStatus** *(string) --* 

            Status of Source Network Replication. Possible values: (a) STOPPED - Source Network is not replicating. (b) IN_PROGRESS - Source Network is being replicated. (c) PROTECTED - Source Network was replicated successfully and is being synchronized for changes. (d) ERROR - Source Network replication has failed

            
          

          - **replicationStatusDetails** *(string) --* 

            Error details in case Source Network replication status is ERROR.

            
          

          - **sourceAccountID** *(string) --* 

            Account ID containing the VPC protected by the Source Network.

            
          

          - **sourceNetworkID** *(string) --* 

            Source Network ID.

            
          

          - **sourceRegion** *(string) --* 

            Region containing the VPC protected by the Source Network.

            
          

          - **sourceVpcID** *(string) --* 

            VPC ID protected by the Source Network.

            
          

          - **tags** *(dict) --* 

            A list of tags associated with the Source Network.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **nextToken** *(string) --* 

        The token of the next Source Networks to retrieve.

        
  
  **Exceptions**
  
  *   :py:class:`drs.Client.exceptions.InternalServerException`

  
  *   :py:class:`drs.Client.exceptions.ThrottlingException`

  
  *   :py:class:`drs.Client.exceptions.ValidationException`

  
  *   :py:class:`drs.Client.exceptions.UninitializedAccountException`

  