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

DescribeInstanceProfiles

Returns a paginated list of instance profiles 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 instance profiles described in the form of key-value pairs.

Valid filter names and values: instance-profile-identifier, instance profile 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 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, AWS DMS includes a pagination token in the response so that you can retrieve the remaining results.

Type: Integer

Required: No

Response Syntax


{
   "InstanceProfiles": [ 
      { 
         "AvailabilityZone": "string",
         "Description": "string",
         "InstanceProfileArn": "string",
         "InstanceProfileCreationTime": "string",
         "InstanceProfileName": "string",
         "KmsKeyArn": "string",
         "NetworkType": "string",
         "PubliclyAccessible": boolean,
         "SubnetGroupIdentifier": "string",
         "VpcSecurityGroups": [ "string" ]
      }
   ],
   "Marker": "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.

InstanceProfiles

A description of instance profiles.

Type: Array of InstanceProfile objects

Marker

Type: String

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 DescribeInstanceProfiles.

Sample Request


{
    "Filters": [
        {
            "Name": "instance-profile-identifier",
            "Values": [
                "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
             ]
        }
    ],
    "MaxRecords": 20,
    "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
}

Example

This example illustrates one usage of DescribeInstanceProfiles.

Sample Response



               {
    [{
        InstanceProfileName: "testConfigIdentifier1",
        Description: "A description",
        InstanceProfileCreationTime: "2023-02-20T14:12:30Z",
        InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:resourceId", 
        AvailabilityZone: "us-east-1a",
        VpcIdentifier: "vpc-cd8c41a9",
        SubnetGroupIdentifier: ["myGroup"],
        VpcSecurityGroups: ["sg-5475435"],
        KmsKeyArn: "arn:aws:kms:us-east-1:012345678901:key/abcdef01-2345-6789-0abc-def012345678",
        EncryptionContext: [
            {
                Key: "aws:servicename:id",
                Value: "redshift"
            },
            {
                Key: "aws:redshift:integration:arn",
                Value: "arn:aws:rds:us-east-1:122333444:integration/0123456789012"
            }
        ],
        PubliclyAccessible: true,
        NetworkType: "DUAL|IPv4"
    },    
    {
        InstanceProfileName: "testMP1",
        InstanceProfileCreationTime: 2023-02-20T14:12:30Z,
        ...
    }]
    Marker: abcdefghijklmnopqrstuvwxyz012
}