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

ListNetworkMigrationMapperSegments

Lists mapper segments, which represent logical groupings of network resources to be migrated together.

Request Syntax


POST /network-migration/ListNetworkMigrationMapperSegments HTTP/1.1
Content-type: application/json

{
   "filters": { 
      "segmentIDs": [ "string" ]
   },
   "maxResults": number,
   "networkMigrationDefinitionID": "string",
   "networkMigrationExecutionID": "string",
   "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

Filters to apply when listing segments.

Type: ListNetworkMigrationMapperSegmentsFilters object

Required: No

maxResults

The maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

networkMigrationDefinitionID

The unique identifier of the network migration definition.

Type: String

Length Constraints: Fixed length of 21.

Pattern: nmd-[0-9a-zA-Z]{17}

Required: Yes

networkMigrationExecutionID

The unique identifier of the network migration execution.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

nextToken

The token for the next page of results.

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": [ 
      { 
         "checksum": { 
            "encryptionAlgorithm": "string",
            "hash": "string"
         },
         "createdAt": number,
         "description": "string",
         "jobID": "string",
         "logicalID": "string",
         "name": "string",
         "networkMigrationDefinitionID": "string",
         "networkMigrationExecutionID": "string",
         "outputS3Configuration": { 
            "s3Bucket": "string",
            "s3BucketOwner": "string",
            "s3Key": "string"
         },
         "referencedSegments": [ "string" ],
         "scopeTags": { 
            "string" : "string" 
         },
         "segmentID": "string",
         "segmentType": "string",
         "targetAccount": "string",
         "updatedAt": number
      }
   ],
   "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

A list of mapper segments.

Type: Array of NetworkMigrationMapperSegment objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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.

AccessDeniedException

Operating denied due to a file permission or access check error.

HTTP Status Code: 403

ResourceNotFoundException

Resource not found exception.

resourceId: Resource ID not found error.
resourceType: Resource type not found error.

HTTP Status Code: 404

ThrottlingException

Reached throttling quota exception.

quotaCode: Reached throttling quota exception.
retryAfterSeconds: Reached throttling quota exception will retry after x seconds.
serviceCode: Reached throttling quota exception service code.

HTTP Status Code: 429

ValidationException

Validate exception.

fieldList: Validate exception field list.
reason: Validate exception reason.

HTTP Status Code: 400