Method: Aws::Drs::Client#describe_source_networks

Defined in:

lib/aws-sdk-drs/client.rb

#describe_source_networks(params = {}) ⇒ Types::DescribeSourceNetworksResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.describe_source_networks({
  filters: {
    origin_account_id: "AccountID",
    origin_region: "AwsRegion",
    source_network_i_ds: ["SourceNetworkID"],
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure

resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].cfn_stack_name #=> String
resp.items[0].last_recovery.api_call_date_time #=> Time
resp.items[0].last_recovery.job_id #=> String
resp.items[0].last_recovery.last_recovery_result #=> String, one of "NOT_STARTED", "IN_PROGRESS", "SUCCESS", "FAIL", "PARTIAL_SUCCESS", "ASSOCIATE_SUCCESS", "ASSOCIATE_FAIL"
resp.items[0].launched_vpc_id #=> String
resp.items[0].replication_status #=> String, one of "STOPPED", "IN_PROGRESS", "PROTECTED", "ERROR"
resp.items[0].replication_status_details #=> String
resp.items[0].source_account_id #=> String
resp.items[0].source_network_id #=> String
resp.items[0].source_region #=> String
resp.items[0].source_vpc_id #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :filters (Types::DescribeSourceNetworksRequestFilters) —

  A set of filters by which to return Source Networks.

• :max_results (Integer) —

  Maximum number of Source Networks to retrieve.

• :next_token (String) —

  The token of the next Source Networks to retrieve.

Returns:

• (Types::DescribeSourceNetworksResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array<Types::SourceNetwork>

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-drs/client.rb', line 1523

def describe_source_networks(params = {}, options = {})
  req = build_request(:describe_source_networks, params)
  req.send_request(options)
end