DescribeMigrationProjects
Returns a paginated list of migration projects for your account in the current region.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"Marker": "string",
"MaxRecords": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
Filters applied to the migration projects described in the form of key-value pairs.
Valid filter names and values:
-
instance-profile-identifier, instance profile arn or name
-
data-provider-identifier, data provider arn or name
-
migration-project-identifier, migration project arn or name
Type: Array of Filter objects
Required: No
-
- Marker
-
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.If
Markeris returned by a previous response, there are more results available. The value ofMarkeris a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.Type: String
Required: No
- MaxRecords
-
The maximum number of records to include in the response. If more records exist than the specified
MaxRecordsvalue, AWS DMS includes a pagination token in the response so that you can retrieve the remaining results.Type: Integer
Required: No
Response Syntax
{
"Marker": "string",
"MigrationProjects": [
{
"Description": "string",
"InstanceProfileArn": "string",
"InstanceProfileName": "string",
"MigrationProjectArn": "string",
"MigrationProjectCreationTime": "string",
"MigrationProjectName": "string",
"SchemaConversionApplicationAttributes": {
"S3BucketPath": "string",
"S3BucketRoleArn": "string"
},
"SourceDataProviderDescriptors": [
{
"DataProviderArn": "string",
"DataProviderName": "string",
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string"
}
],
"TargetDataProviderDescriptors": [
{
"DataProviderArn": "string",
"DataProviderName": "string",
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string"
}
],
"TransformationRules": "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.
- Marker
-
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.If
Markeris returned by a previous response, there are more results available. The value ofMarkeris a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.Type: String
- MigrationProjects
-
A description of migration projects.
Type: Array of MigrationProject objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- FailedDependencyFault
-
A dependency threw an exception.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeMigrationProjects.
Sample Request
{ "Filters": [
{
"Name": "migration-project-identifier",
"Values": [
"arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ12345678901"
]
}
],
"MaxRecords": 20,
"Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
