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 the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
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
.
This operation returns paginated results.
Synopsis
- data DescribePrincipalIdFormat = DescribePrincipalIdFormat' {}
- newDescribePrincipalIdFormat :: DescribePrincipalIdFormat
- describePrincipalIdFormat_dryRun :: Lens' DescribePrincipalIdFormat (Maybe Bool)
- describePrincipalIdFormat_maxResults :: Lens' DescribePrincipalIdFormat (Maybe Natural)
- describePrincipalIdFormat_nextToken :: Lens' DescribePrincipalIdFormat (Maybe Text)
- describePrincipalIdFormat_resources :: Lens' DescribePrincipalIdFormat (Maybe [Text])
- data DescribePrincipalIdFormatResponse = DescribePrincipalIdFormatResponse' {
- nextToken :: Maybe Text
- principals :: Maybe [PrincipalIdFormat]
- httpStatus :: Int
- newDescribePrincipalIdFormatResponse :: Int -> DescribePrincipalIdFormatResponse
- describePrincipalIdFormatResponse_nextToken :: Lens' DescribePrincipalIdFormatResponse (Maybe Text)
- describePrincipalIdFormatResponse_principals :: Lens' DescribePrincipalIdFormatResponse (Maybe [PrincipalIdFormat])
- describePrincipalIdFormatResponse_httpStatus :: Lens' DescribePrincipalIdFormatResponse Int
Creating a Request
data DescribePrincipalIdFormat Source #
See: newDescribePrincipalIdFormat
smart constructor.
DescribePrincipalIdFormat' | |
|
Instances
newDescribePrincipalIdFormat :: DescribePrincipalIdFormat Source #
Create a value of DescribePrincipalIdFormat
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:
$sel:dryRun:DescribePrincipalIdFormat'
, describePrincipalIdFormat_dryRun
- Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
$sel:maxResults:DescribePrincipalIdFormat'
, describePrincipalIdFormat_maxResults
- The maximum number of results to return in a single call. To retrieve
the remaining results, make another call with the returned NextToken
value.
DescribePrincipalIdFormat
, describePrincipalIdFormat_nextToken
- The token to request the next page of results.
DescribePrincipalIdFormat
, describePrincipalIdFormat_resources
- 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
describePrincipalIdFormat_dryRun :: Lens' DescribePrincipalIdFormat (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
describePrincipalIdFormat_maxResults :: Lens' DescribePrincipalIdFormat (Maybe Natural) Source #
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
describePrincipalIdFormat_nextToken :: Lens' DescribePrincipalIdFormat (Maybe Text) Source #
The token to request the next page of results.
describePrincipalIdFormat_resources :: Lens' DescribePrincipalIdFormat (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 DescribePrincipalIdFormatResponse Source #
See: newDescribePrincipalIdFormatResponse
smart constructor.
DescribePrincipalIdFormatResponse' | |
|
Instances
newDescribePrincipalIdFormatResponse Source #
Create a value of DescribePrincipalIdFormatResponse
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:
DescribePrincipalIdFormat
, describePrincipalIdFormatResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:principals:DescribePrincipalIdFormatResponse'
, describePrincipalIdFormatResponse_principals
- Information about the ID format settings for the ARN.
$sel:httpStatus:DescribePrincipalIdFormatResponse'
, describePrincipalIdFormatResponse_httpStatus
- The response's http status code.
Response Lenses
describePrincipalIdFormatResponse_nextToken :: Lens' DescribePrincipalIdFormatResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
describePrincipalIdFormatResponse_principals :: Lens' DescribePrincipalIdFormatResponse (Maybe [PrincipalIdFormat]) Source #
Information about the ID format settings for the ARN.
describePrincipalIdFormatResponse_httpStatus :: Lens' DescribePrincipalIdFormatResponse Int Source #
The response's http status code.