Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeExtensionPackAssociations

Returns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.

Required permissions: dms:ListExtensionPacks. For more information, see Actions, resources, and condition keys for Amazon Database Migration Service.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Marker": "string",
   "MaxRecords": number,
   "MigrationProjectIdentifier": "string"
}

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

The filters to apply to the extension pack association requests.

The following filter names are supported:

request-id – The request identifier.
status – The operation status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED.

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 Marker is returned by a previous response, there are more results available. The value of Marker is 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 MaxRecords value, Amazon DMS includes a pagination token in the response so that you can retrieve the remaining results.

Type: Integer

Required: No

MigrationProjectIdentifier

The name or Amazon Resource Name (ARN) for the migration project.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax


{
   "Marker": "string",
   "Requests": [ 
      { 
         "Error": { ... },
         "ExportSqlDetails": { 
            "ObjectURL": "string",
            "S3ObjectKey": "string"
         },
         "MigrationProjectArn": "string",
         "Progress": { 
            "ProcessedObject": { 
               "EndpointType": "string",
               "Name": "string",
               "Type": "string"
            },
            "ProgressPercent": number,
            "ProgressStep": "string",
            "TotalObjects": number
         },
         "RequestIdentifier": "string",
         "Status": "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

Type: String

Requests

A paginated list of extension pack associations for the specified migration project.

Note

Amazon DMS never populates the ExportSqlDetails field for this operation.

Type: Array of SchemaConversionRequest objects

Errors

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

Examples

Retrieve the status of extension pack associations

The following example retrieves the status of operations that apply an extension pack to the target database, identified by their request IDs.

Sample Request


POST / HTTP/1.1
Host: dms.<region>.<domain>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<SignedHeaders>, Signature=<Signature>
X-Amz-Date: <Date>
X-Amz-Target: AmazonDMSv20160101.DescribeExtensionPackAssociations
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
    "Filters": [
        {
            "Name": "request-id",
            "Values": ["a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"]
        }
    ]
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "Requests": [
        {
            "Status": "SUCCESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
        },
        {
            "Status": "IN_PROGRESS",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Progress": {
                "ProgressPercent": 50.0,
                "ProgressStep": "IN_PROGRESS"
            }
        },
        {
            "Status": "FAILED",
            "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
            "Error": {
                "defaultErrorDetails": {
                    "Message": "The database user in your target secret does not have sufficient privileges. Grant the required privileges and try again."
                }
            }
        }
    ]
}