# DescribeIdentityIdFormat
<a name="API_DescribeIdentityIdFormat"></a>

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see [Resource IDs](https://docs.amazonaws.cn/AWSEC2/latest/UserGuide/resource-ids.html) in the *Amazon Elastic Compute Cloud User Guide*. 

The following resource types support longer IDs: `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 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. 

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

## Request Parameters
<a name="API_DescribeIdentityIdFormat_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 role, IAM user, or the root user.  
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 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`   
Type: String  
Required: No

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

The following elements are returned by the service.

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

 **statusSet**   
Information about the ID format for the resources.  
Type: Array of [IdFormat](API_IdFormat.md) objects

## Errors
<a name="API_DescribeIdentityIdFormat_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_DescribeIdentityIdFormat_Examples"></a>

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

This example describes the ID format for the IAM role 'EC2Role'.

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

```
https://ec2.amazonaws.com/?Action=DescribeIdentityIdFormat
&PrincipalArn=arn:aws:iam::123456789012:role/EC2Role
&AUTHPARAMS
```

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

```
<DescribeIdentityIdFormatResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
    <statusSet>
        <item>
            <useLongIds>true</useLongIds>
            <deadline>2016-12-15T12:00:00Z</deadline>
            <resource>reservation</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <deadline>2016-12-15T12:00:00Z</deadline>
            <resource>instance</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <deadline>2016-12-15T12:00:00Z</deadline>
            <resource>volume</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <deadline>2016-12-15T12:00:00Z</deadline>
            <resource>snapshot</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>network-interface-attachment</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>network-interface</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>elastic-ip-allocation</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>elastic-ip-association</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>vpc</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>subnet</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>route-table</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>route-table-association</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>network-acl</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>network-acl-association</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>dhcp-options</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>internet-gateway</resource>
        </item>
        <item>
            <useLongIds>false</useLongIds>
            <resource>vpc-cidr-block-association</resource>
        </item>
        <item>
            <useLongIds>false</useLongIds>
            <resource>vpc-ipv6-cidr-block-association</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>subnet-ipv6-cidr-block-association</resource>
        </item>
        <item>
            <useLongIds>false</useLongIds>
            <resource>vpc-peering-connection</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>security-group</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>flow-log</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>customer-gateway</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>vpc-endpoint</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>vpn-connection</resource>
        </item>
        <item>
            <useLongIds>true</useLongIds>
            <resource>vpn-gateway</resource>
        </item>
    </statusSet>
</DescribeIdentityIdFormatResponse>
```

## See Also
<a name="API_DescribeIdentityIdFormat_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/DescribeIdentityIdFormat) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/ec2-2016-11-15/DescribeIdentityIdFormat) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIdentityIdFormat)