Amazon DMS Dms Instance Profile API
The Dms Instance Profile API from Amazon DMS — 4 operation(s) for dms instance profile.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-dms:amazon-dms-instance-profile-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AWS Database Migration Service Instance Profile API
version: '2016-01-01'
description: Generated from AWS's published Smithy model for AWS Database Migration Service. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://dms.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Instance Profile
paths:
/#CreateInstanceProfile:
post:
operationId: CreateInstanceProfile
summary: Create Instance Profile
description: 'Creates the instance profile using the specified parameters. Required permissions: dms:CreateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateInstanceProfileResponse'
example:
InstanceProfile:
InstanceProfileArn: arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS
KmsKeyArn: arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
PubliclyAccessible: false
NetworkType: IPV4
InstanceProfileName: example-instance-profile
Description: Example instance profile for documentation
InstanceProfileCreationTime: '2026-01-09T12:30:00.000000Z'
SubnetGroupIdentifier: example-replication-subnet-group
VpcSecurityGroups:
- sg-0123456789abcdef0
'400':
description: AccessDeniedFault; FailedDependencyFault; InvalidResourceStateFault; KMSKeyNotAccessibleFault; ResourceAlreadyExistsFault; ResourceNotFoundFault; ResourceQuotaExceededFault; S3AccessDeniedFault; S3ResourceNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.CreateInstanceProfile
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateInstanceProfileMessage'
example:
InstanceProfileName: example-instance-profile
Description: Example instance profile for documentation
SubnetGroupIdentifier: example-replication-subnet-group
VpcSecurityGroups:
- sg-0123456789abcdef0
KmsKeyArn: arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
NetworkType: IPV4
PubliclyAccessible: false
tags:
- Instance Profile
/#DeleteInstanceProfile:
post:
operationId: DeleteInstanceProfile
summary: Delete Instance Profile
description: 'Deletes the specified instance profile. Required permissions: dms:DeleteInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteInstanceProfileResponse'
example:
InstanceProfile:
InstanceProfileArn: arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS
KmsKeyArn: arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
PubliclyAccessible: false
NetworkType: IPV4
InstanceProfileName: example-instance-profile
Description: Example instance profile for documentation
InstanceProfileCreationTime: '2026-01-09T12:30:00.000000Z'
SubnetGroupIdentifier: example-replication-subnet-group
VpcSecurityGroups:
- sg-0123456789abcdef0
'400':
description: AccessDeniedFault; FailedDependencyFault; InvalidResourceStateFault; ResourceNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.DeleteInstanceProfile
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteInstanceProfileMessage'
example:
InstanceProfileIdentifier: arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS
tags:
- Instance Profile
/#DescribeInstanceProfiles:
post:
operationId: DescribeInstanceProfiles
summary: Describe Instance Profiles
description: 'Returns a paginated list of instance profiles for your account in the current region. Required permissions: dms:ListInstanceProfiles. For more information, see Actions, resources, and condition keys for Database Migration Service.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeInstanceProfilesResponse'
example:
InstanceProfiles:
- InstanceProfileArn: arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS
KmsKeyArn: arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
PubliclyAccessible: false
NetworkType: IPV4
InstanceProfileName: example-instance-profile
Description: Example instance profile for documentation
InstanceProfileCreationTime: '2026-01-09T12:30:00.000000Z'
SubnetGroupIdentifier: example-replication-subnet-group
VpcSecurityGroups:
- sg-0123456789abcdef0
'400':
description: AccessDeniedFault; FailedDependencyFault; ResourceNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.DescribeInstanceProfiles
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeInstanceProfilesMessage'
example:
Filters:
- Name: instance-profile-identifier
Values:
- arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS
tags:
- Instance Profile
/#ModifyInstanceProfile:
post:
operationId: ModifyInstanceProfile
summary: Modify Instance Profile
description: 'Modifies the specified instance profile using the provided parameters. Required permissions: dms:UpdateInstanceProfile. For more information, see Actions, resources, and condition keys for Database Migration Service. All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ModifyInstanceProfileResponse'
example:
InstanceProfile:
InstanceProfileArn: arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS
KmsKeyArn: arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
PubliclyAccessible: false
NetworkType: DUAL
InstanceProfileName: example-instance-profile
Description: Updated instance profile description
InstanceProfileCreationTime: '2026-01-09T12:30:00.000000Z'
SubnetGroupIdentifier: example-replication-subnet-group
VpcSecurityGroups:
- sg-0123456789abcdef0
'400':
description: AccessDeniedFault; FailedDependencyFault; InvalidResourceStateFault; KMSKeyNotAccessibleFault; ResourceNotFoundFault; S3AccessDeniedFault; S3ResourceNotFoundFault
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedFault'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonDMSv20160101.ModifyInstanceProfile
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ModifyInstanceProfileMessage'
example:
InstanceProfileIdentifier: arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS
Description: Updated instance profile description
NetworkType: DUAL
tags:
- Instance Profile
components:
schemas:
Tag:
type: object
properties:
Key:
type: string
description: 'A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
Value:
type: string
description: 'A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can''t be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'' (Java regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
ResourceArn:
type: string
description: The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
ModifyInstanceProfileMessage:
type: object
properties:
InstanceProfileIdentifier:
type: string
description: The identifier of the instance profile. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
AvailabilityZone:
type: string
description: The Availability Zone where the instance profile runs.
KmsKeyArn:
type: string
description: The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile. If you don't specify a value for the KmsKeyArn parameter, then DMS uses an Amazon Web Services owned encryption key to encrypt your resources.
PubliclyAccessible:
type: boolean
description: Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
NetworkType:
type: string
description: Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
InstanceProfileName:
type: string
description: A user-friendly name for the instance profile.
Description:
type: string
description: A user-friendly description for the instance profile.
SubnetGroupIdentifier:
type: string
description: A subnet group to associate with the instance profile.
VpcSecurityGroups:
type: array
items:
type: string
description: Specifies the VPC security groups to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
required:
- InstanceProfileIdentifier
AccessDeniedFault:
type: object
properties:
message:
type: string
DescribeInstanceProfilesResponse:
type: object
properties:
Marker:
type: string
description: 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.
InstanceProfiles:
type: array
items:
$ref: '#/components/schemas/InstanceProfile'
description: A description of instance profiles.
Filter:
type: object
properties:
Name:
type: string
description: The name of the filter as specified for a Describe* or similar operation.
Values:
type: array
items:
type: string
description: The filter value, which can specify one or more values used to narrow the returned results.
required:
- Name
- Values
DescribeInstanceProfilesMessage:
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: 'The filters to apply to the instance profiles. The following filter names are supported: instance-profile-identifier – The instance profile name or ARN.'
MaxRecords:
type: integer
description: The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
Marker:
type: string
description: 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.
InstanceProfile:
type: object
properties:
InstanceProfileArn:
type: string
description: The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
AvailabilityZone:
type: string
description: The Availability Zone where the instance profile runs.
KmsKeyArn:
type: string
description: The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile. If you don't specify a value for the KmsKeyArn parameter, then DMS uses an Amazon Web Services owned encryption key to encrypt your resources.
PubliclyAccessible:
type: boolean
description: Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
NetworkType:
type: string
description: Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
InstanceProfileName:
type: string
description: The user-friendly name for the instance profile.
Description:
type: string
description: A description of the instance profile. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
InstanceProfileCreationTime:
type: string
format: date-time
description: The time the instance profile was created.
SubnetGroupIdentifier:
type: string
description: The identifier of the subnet group that is associated with the instance profile.
VpcSecurityGroups:
type: array
items:
type: string
description: The VPC security groups that are used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
DeleteInstanceProfileResponse:
type: object
properties:
InstanceProfile:
$ref: '#/components/schemas/InstanceProfile'
ModifyInstanceProfileResponse:
type: object
properties:
InstanceProfile:
$ref: '#/components/schemas/InstanceProfile'
CreateInstanceProfileResponse:
type: object
properties:
InstanceProfile:
$ref: '#/components/schemas/InstanceProfile'
CreateInstanceProfileMessage:
type: object
properties:
AvailabilityZone:
type: string
description: The Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem us-east-1d.
KmsKeyArn:
type: string
description: The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile. If you don't specify a value for the KmsKeyArn parameter, then DMS uses an Amazon Web Services owned encryption key to encrypt your resources.
PubliclyAccessible:
type: boolean
description: Specifies the accessibility options for the instance profile. A value of true represents an instance profile with a public IP address. A value of false represents an instance profile with a private IP address. The default value is true.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: One or more tags to be assigned to the instance profile.
NetworkType:
type: string
description: Specifies the network type for the instance profile. A value of IPV4 represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value of DUAL represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.
InstanceProfileName:
type: string
description: A user-friendly name for the instance profile.
Description:
type: string
description: A user-friendly description of the instance profile.
SubnetGroupIdentifier:
type: string
description: A subnet group to associate with the instance profile.
VpcSecurityGroups:
type: array
items:
type: string
description: Specifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
DeleteInstanceProfileMessage:
type: object
properties:
InstanceProfileIdentifier:
type: string
description: The identifier of the instance profile to delete.
required:
- InstanceProfileIdentifier
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: dms
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)