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.DescribePrincipalIdFormat

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePrincipalIdFormat Source #

See: newDescribePrincipalIdFormat smart constructor.

Constructors

DescribePrincipalIdFormat'

Fields

dryRun :: Maybe Bool
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.
maxResults :: Maybe Natural
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
nextToken :: Maybe Text
The token to request the next page of results.
resources :: Maybe [Text]
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

Instances

Instances details

ToHeaders DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods toHeaders :: DescribePrincipalIdFormat -> [Header] #
ToPath DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods toPath :: DescribePrincipalIdFormat -> ByteString #
ToQuery DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods toQuery :: DescribePrincipalIdFormat -> QueryString #
AWSPager DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods page :: DescribePrincipalIdFormat -> AWSResponse DescribePrincipalIdFormat -> Maybe DescribePrincipalIdFormat #
AWSRequest DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Associated Types type AWSResponse DescribePrincipalIdFormat # Methods request :: (Service -> Service) -> DescribePrincipalIdFormat -> Request DescribePrincipalIdFormat # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePrincipalIdFormat -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePrincipalIdFormat))) #
Generic DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Associated Types type Rep DescribePrincipalIdFormat :: Type -> Type # Methods from :: DescribePrincipalIdFormat -> Rep DescribePrincipalIdFormat x # to :: Rep DescribePrincipalIdFormat x -> DescribePrincipalIdFormat #
Read DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods readsPrec :: Int -> ReadS DescribePrincipalIdFormat # readList :: ReadS [DescribePrincipalIdFormat] # readPrec :: ReadPrec DescribePrincipalIdFormat # readListPrec :: ReadPrec [DescribePrincipalIdFormat] #
Show DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods showsPrec :: Int -> DescribePrincipalIdFormat -> ShowS # show :: DescribePrincipalIdFormat -> String # showList :: [DescribePrincipalIdFormat] -> ShowS #
NFData DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods rnf :: DescribePrincipalIdFormat -> () #
Eq DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods (==) :: DescribePrincipalIdFormat -> DescribePrincipalIdFormat -> Bool # (/=) :: DescribePrincipalIdFormat -> DescribePrincipalIdFormat -> Bool #
Hashable DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods hashWithSalt :: Int -> DescribePrincipalIdFormat -> Int # hash :: DescribePrincipalIdFormat -> Int #
type AWSResponse DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat type AWSResponse DescribePrincipalIdFormat = DescribePrincipalIdFormatResponse
type Rep DescribePrincipalIdFormat Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat type Rep DescribePrincipalIdFormat = D1 ('MetaData "DescribePrincipalIdFormat" "Amazonka.EC2.DescribePrincipalIdFormat" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribePrincipalIdFormat'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

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.

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 #

Destructuring the Response

data DescribePrincipalIdFormatResponse Source #

See: newDescribePrincipalIdFormatResponse smart constructor.

Constructors

DescribePrincipalIdFormatResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is null when there are no more results to return. principals :: Maybe [PrincipalIdFormat] Information about the ID format settings for the ARN. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribePrincipalIdFormatResponse Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Associated Types type Rep DescribePrincipalIdFormatResponse :: Type -> Type # Methods from :: DescribePrincipalIdFormatResponse -> Rep DescribePrincipalIdFormatResponse x # to :: Rep DescribePrincipalIdFormatResponse x -> DescribePrincipalIdFormatResponse #
Read DescribePrincipalIdFormatResponse Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods readsPrec :: Int -> ReadS DescribePrincipalIdFormatResponse # readList :: ReadS [DescribePrincipalIdFormatResponse] # readPrec :: ReadPrec DescribePrincipalIdFormatResponse # readListPrec :: ReadPrec [DescribePrincipalIdFormatResponse] #
Show DescribePrincipalIdFormatResponse Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods showsPrec :: Int -> DescribePrincipalIdFormatResponse -> ShowS # show :: DescribePrincipalIdFormatResponse -> String # showList :: [DescribePrincipalIdFormatResponse] -> ShowS #
NFData DescribePrincipalIdFormatResponse Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods rnf :: DescribePrincipalIdFormatResponse -> () #
Eq DescribePrincipalIdFormatResponse Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat Methods (==) :: DescribePrincipalIdFormatResponse -> DescribePrincipalIdFormatResponse -> Bool # (/=) :: DescribePrincipalIdFormatResponse -> DescribePrincipalIdFormatResponse -> Bool #
type Rep DescribePrincipalIdFormatResponse Source #
Instance details Defined in Amazonka.EC2.DescribePrincipalIdFormat type Rep DescribePrincipalIdFormatResponse = D1 ('MetaData "DescribePrincipalIdFormatResponse" "Amazonka.EC2.DescribePrincipalIdFormat" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribePrincipalIdFormatResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PrincipalIdFormat])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePrincipalIdFormatResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribePrincipalIdFormatResponse'`
-> DescribePrincipalIdFormatResponse

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.