# ModifyInstanceProfile
<a name="API_ModifyInstanceProfile"></a>

Modifies the specified instance profile using the provided parameters.

**Note**  
All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.

## Request Syntax
<a name="API_ModifyInstanceProfile_RequestSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "Description": "string",
   "InstanceProfileIdentifier": "string",
   "InstanceProfileName": "string",
   "KmsKeyArn": "string",
   "NetworkType": "string",
   "PubliclyAccessible": boolean,
   "SubnetGroupIdentifier": "string",
   "VpcSecurityGroups": [ "string" ]
}
```

## Request Parameters
<a name="API_ModifyInstanceProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-AvailabilityZone"></a>
The Availability Zone where the instance profile runs.  
Type: String  
Required: No

 ** [Description](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-Description"></a>
A user-friendly description for the instance profile.  
Type: String  
Required: No

 ** [InstanceProfileIdentifier](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-InstanceProfileIdentifier"></a>
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.  
Type: String  
Required: Yes

 ** [InstanceProfileName](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-InstanceProfileName"></a>
A user-friendly name for the instance profile.  
Type: String  
Required: No

 ** [KmsKeyArn](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-KmsKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS 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 AWS DMS uses an AWS owned encryption key to encrypt your resources.  
Type: String  
Required: No

 ** [NetworkType](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-NetworkType"></a>
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.  
Type: String  
Required: No

 ** [PubliclyAccessible](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-PubliclyAccessible"></a>
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`.  
Type: Boolean  
Required: No

 ** [SubnetGroupIdentifier](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-SubnetGroupIdentifier"></a>
A subnet group to associate with the instance profile.  
Type: String  
Required: No

 ** [VpcSecurityGroups](#API_ModifyInstanceProfile_RequestSyntax) **   <a name="DMS-ModifyInstanceProfile-request-VpcSecurityGroups"></a>
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.  
Type: Array of strings  
Required: No

## Response Syntax
<a name="API_ModifyInstanceProfile_ResponseSyntax"></a>

```
{
   "InstanceProfile": { 
      "AvailabilityZone": "string",
      "Description": "string",
      "InstanceProfileArn": "string",
      "InstanceProfileCreationTime": "string",
      "InstanceProfileName": "string",
      "KmsKeyArn": "string",
      "NetworkType": "string",
      "PubliclyAccessible": boolean,
      "SubnetGroupIdentifier": "string",
      "VpcSecurityGroups": [ "string" ]
   }
}
```

## Response Elements
<a name="API_ModifyInstanceProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceProfile](#API_ModifyInstanceProfile_ResponseSyntax) **   <a name="DMS-ModifyInstanceProfile-response-InstanceProfile"></a>
The instance profile that was modified.  
Type: [InstanceProfile](API_InstanceProfile.md) object

## Errors
<a name="API_ModifyInstanceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedFault **   
 AWS DMS was denied access to the endpoint. Check that the role is correctly configured.    
 ** message **   

HTTP Status Code: 400

 ** FailedDependencyFault **   
A dependency threw an exception.  
HTTP Status Code: 400

 ** InvalidResourceStateFault **   
The resource is in a state that prevents it from being used for database migration.    
 ** message **   

HTTP Status Code: 400

 ** KMSKeyNotAccessibleFault **   
 AWS DMS cannot access the KMS key.    
 ** message **   

HTTP Status Code: 400

 ** ResourceNotFoundFault **   
The resource could not be found.    
 ** message **   

HTTP Status Code: 400

 ** S3AccessDeniedFault **   
Insufficient privileges are preventing access to an Amazon S3 object.  
HTTP Status Code: 400

 ** S3ResourceNotFoundFault **   
A specified Amazon S3 bucket, bucket folder, or other object can't be found.  
HTTP Status Code: 400

## Examples
<a name="API_ModifyInstanceProfile_Examples"></a>

### Example
<a name="API_ModifyInstanceProfile_Example_1"></a>

This example illustrates one usage of ModifyInstanceProfile.

#### Sample Request
<a name="API_ModifyInstanceProfile_Example_1_Request"></a>

```
{
    "InstanceProfileIdentifier": "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", 
    "SubnetGroupIdentifier": "myuser-subnet-group",
    "VpcSecurityGroupIds": ["sg-0123456789abcdef0"],
    "PubliclyAccessible": true,
    "KmsKeyArn": "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
    "InstanceProfileName": "new-name",
    "Description": "Description",
    "NetworkType": "DUAL"
}
```

## See Also
<a name="API_ModifyInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dms-2016-01-01/ModifyInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dms-2016-01-01/ModifyInstanceProfile)