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 |
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types 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.
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 IAM user who makes the request; they do not
apply to the entire Amazon Web Services account. By default, an IAM user
defaults to the same settings as the root user, unless they explicitly
override the settings by running the ModifyIdFormat command. Resources
created with longer IDs are visible to all IAM users, regardless of
these settings and provided that they have permission to use the
relevant Describe
command for the resource type.
Synopsis
- data DescribeIdFormat = DescribeIdFormat' {}
- newDescribeIdFormat :: DescribeIdFormat
- describeIdFormat_resource :: Lens' DescribeIdFormat (Maybe Text)
- data DescribeIdFormatResponse = DescribeIdFormatResponse' {
- statuses :: Maybe [IdFormat]
- httpStatus :: Int
- newDescribeIdFormatResponse :: Int -> DescribeIdFormatResponse
- describeIdFormatResponse_statuses :: Lens' DescribeIdFormatResponse (Maybe [IdFormat])
- describeIdFormatResponse_httpStatus :: Lens' DescribeIdFormatResponse Int
Creating a Request
data DescribeIdFormat Source #
See: newDescribeIdFormat
smart constructor.
DescribeIdFormat' | |
|
Instances
newDescribeIdFormat :: DescribeIdFormat Source #
Create a value of DescribeIdFormat
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:
DescribeIdFormat
, describeIdFormat_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
Request Lenses
describeIdFormat_resource :: Lens' DescribeIdFormat (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
Destructuring the Response
data DescribeIdFormatResponse Source #
See: newDescribeIdFormatResponse
smart constructor.
DescribeIdFormatResponse' | |
|
Instances
newDescribeIdFormatResponse Source #
Create a value of DescribeIdFormatResponse
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:
DescribeIdFormatResponse
, describeIdFormatResponse_statuses
- Information about the ID format for the resource.
$sel:httpStatus:DescribeIdFormatResponse'
, describeIdFormatResponse_httpStatus
- The response's http status code.
Response Lenses
describeIdFormatResponse_statuses :: Lens' DescribeIdFormatResponse (Maybe [IdFormat]) Source #
Information about the ID format for the resource.
describeIdFormatResponse_httpStatus :: Lens' DescribeIdFormatResponse Int Source #
The response's http status code.