Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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
.
Synopsis
- describePrincipalIdFormat :: DescribePrincipalIdFormat
- data DescribePrincipalIdFormat
- dpifResources :: Lens' DescribePrincipalIdFormat [Text]
- dpifNextToken :: Lens' DescribePrincipalIdFormat (Maybe Text)
- dpifDryRun :: Lens' DescribePrincipalIdFormat (Maybe Bool)
- dpifMaxResults :: Lens' DescribePrincipalIdFormat (Maybe Int)
- describePrincipalIdFormatResponse :: Int -> DescribePrincipalIdFormatResponse
- data DescribePrincipalIdFormatResponse
- dpifrsPrincipals :: Lens' DescribePrincipalIdFormatResponse [PrincipalIdFormat]
- dpifrsNextToken :: Lens' DescribePrincipalIdFormatResponse (Maybe Text)
- dpifrsResponseStatus :: Lens' DescribePrincipalIdFormatResponse Int
Creating a Request
describePrincipalIdFormat :: DescribePrincipalIdFormat Source #
Creates a value of DescribePrincipalIdFormat
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpifResources
- 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
dpifNextToken
- The token to request the next page of results.dpifDryRun
- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.dpifMaxResults
- The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
data DescribePrincipalIdFormat Source #
See: describePrincipalIdFormat
smart constructor.
Instances
Request Lenses
dpifResources :: Lens' DescribePrincipalIdFormat [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
dpifNextToken :: Lens' DescribePrincipalIdFormat (Maybe Text) Source #
The token to request the next page of results.
dpifDryRun :: 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
.
dpifMaxResults :: Lens' DescribePrincipalIdFormat (Maybe Int) 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.
Destructuring the Response
describePrincipalIdFormatResponse Source #
Creates a value of DescribePrincipalIdFormatResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpifrsPrincipals
- Information about the ID format settings for the ARN.dpifrsNextToken
- The token to use to retrieve the next page of results. This value is null when there are no more results to return.dpifrsResponseStatus
- -- | The response status code.
data DescribePrincipalIdFormatResponse Source #
See: describePrincipalIdFormatResponse
smart constructor.
Instances
Response Lenses
dpifrsPrincipals :: Lens' DescribePrincipalIdFormatResponse [PrincipalIdFormat] Source #
Information about the ID format settings for the ARN.
dpifrsNextToken :: 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.
dpifrsResponseStatus :: Lens' DescribePrincipalIdFormatResponse Int Source #
- - | The response status code.