Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeSourceNetworks

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

Request Syntax


POST /DescribeSourceNetworks HTTP/1.1
Content-type: application/json

{
   "filters": { 
      "originAccountID": "string",
      "originRegion": "string",
      "sourceNetworkIDs": [ "string" ]
   },
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

A set of filters by which to return Source Networks.

Type: DescribeSourceNetworksRequestFilters object

Required: No

maxResults

Maximum number of Source Networks to retrieve.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

nextToken

The token of the next Source Networks to retrieve.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "cfnStackName": "string",
         "lastRecovery": { 
            "apiCallDateTime": "string",
            "jobID": "string",
            "lastRecoveryResult": "string"
         },
         "launchedVpcID": "string",
         "replicationStatus": "string",
         "replicationStatusDetails": "string",
         "sourceAccountID": "string",
         "sourceNetworkID": "string",
         "sourceRegion": "string",
         "sourceVpcID": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

An array of Source Networks.

Type: Array of SourceNetwork objects

nextToken

The token of the next Source Networks to retrieve.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UninitializedAccountException

The account performing the request has not been initialized.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400