| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.EC2.DescribeIdentityIdFormat
Description
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 in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle |
conversion-task | customer-gateway | dhcp-options |
elastic-ip-allocation | elastic-ip-association | export-task |
flow-log | image | import-task | instance | internet-gateway |
network-acl | network-acl-association | network-interface |
network-interface-attachment | prefix-list | reservation |
route-table | route-table-association | security-group |
snapshot | subnet | subnet-cidr-block-association | volume |
vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
Synopsis
- data DescribeIdentityIdFormat = DescribeIdentityIdFormat' {
- resource :: Maybe Text
- principalArn :: Text
- newDescribeIdentityIdFormat :: Text -> DescribeIdentityIdFormat
- describeIdentityIdFormat_resource :: Lens' DescribeIdentityIdFormat (Maybe Text)
- describeIdentityIdFormat_principalArn :: Lens' DescribeIdentityIdFormat Text
- data DescribeIdentityIdFormatResponse = DescribeIdentityIdFormatResponse' {
- statuses :: Maybe [IdFormat]
- httpStatus :: Int
- newDescribeIdentityIdFormatResponse :: Int -> DescribeIdentityIdFormatResponse
- describeIdentityIdFormatResponse_statuses :: Lens' DescribeIdentityIdFormatResponse (Maybe [IdFormat])
- describeIdentityIdFormatResponse_httpStatus :: Lens' DescribeIdentityIdFormatResponse Int
Creating a Request
data DescribeIdentityIdFormat Source #
See: newDescribeIdentityIdFormat smart constructor.
Constructors
| DescribeIdentityIdFormat' | |
Fields
| |
Instances
newDescribeIdentityIdFormat Source #
Create a value of DescribeIdentityIdFormat with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeIdentityIdFormat, describeIdentityIdFormat_resource - The type of resource: bundle | conversion-task | customer-gateway
| dhcp-options | elastic-ip-allocation | elastic-ip-association |
export-task | flow-log | image | import-task | instance |
internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list |
reservation | route-table | route-table-association |
security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection
| vpn-connection | vpn-gateway
$sel:principalArn:DescribeIdentityIdFormat', describeIdentityIdFormat_principalArn - The ARN of the principal, which can be an IAM role, IAM user, or the
root user.
Request Lenses
describeIdentityIdFormat_resource :: Lens' DescribeIdentityIdFormat (Maybe Text) Source #
The type of resource: bundle | conversion-task | customer-gateway
| dhcp-options | elastic-ip-allocation | elastic-ip-association |
export-task | flow-log | image | import-task | instance |
internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list |
reservation | route-table | route-table-association |
security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection
| vpn-connection | vpn-gateway
describeIdentityIdFormat_principalArn :: Lens' DescribeIdentityIdFormat Text Source #
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
Destructuring the Response
data DescribeIdentityIdFormatResponse Source #
See: newDescribeIdentityIdFormatResponse smart constructor.
Constructors
| DescribeIdentityIdFormatResponse' | |
Fields
| |
Instances
newDescribeIdentityIdFormatResponse Source #
Create a value of DescribeIdentityIdFormatResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeIdentityIdFormatResponse, describeIdentityIdFormatResponse_statuses - Information about the ID format for the resources.
$sel:httpStatus:DescribeIdentityIdFormatResponse', describeIdentityIdFormatResponse_httpStatus - The response's http status code.
Response Lenses
describeIdentityIdFormatResponse_statuses :: Lens' DescribeIdentityIdFormatResponse (Maybe [IdFormat]) Source #
Information about the ID format for the resources.
describeIdentityIdFormatResponse_httpStatus :: Lens' DescribeIdentityIdFormatResponse Int Source #
The response's http status code.