# ModifyIdentityIdFormat
<a name="API_ModifyIdentityIdFormat"></a>

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. 

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. 

For more information, see [Resource IDs](https://docs.amazonaws.cn/AWSEC2/latest/UserGuide/resource-ids.html) in the *Amazon Elastic Compute Cloud User Guide*. 

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. 

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant `Describe` command for the resource type.

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

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **PrincipalArn**   
The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify `all` to modify the ID format for all IAM users, IAM roles, and the root user of the account.  
Type: String  
Required: Yes

 **Resource**   
The type of resource: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`.  
Alternatively, use the `all-current` option to include all resource types that are currently within their opt-in period for longer IDs.  
Type: String  
Required: Yes

 **UseLongIds**   
Indicates whether the resource should use longer IDs (17-character IDs)  
Type: Boolean  
Required: Yes

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

The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

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

For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

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

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

This example sets the UseLongIds parameter to true for instances launched by the IAM role 'EC2Role'. Instances launched by the IAM role receive longer IDs. 

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

```
https://ec2.amazonaws.com/?Action=ModifyIdentityFormat
&Resource=instance
&UseLongIds=true
&PrincipalArn=arn:aws:iam::123456789012:role/EC2Role
&AUTHPARAMS
```

#### Sample Response
<a name="API_ModifyIdentityIdFormat_Example_1_Response"></a>

```
<ModifyIdentityIdFormatResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
  <requestId>92c1af09-cb4c-410e-8a96-EXAMPLE</requestId>
  <return>true</return>
</ModifyIdentityIdFormatResponse>
```

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

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