Network.AWS.EC2.DescribePrincipalIdFormat

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 .

Creating a Request

describePrincipalIdFormat :: DescribePrincipalIdFormat

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 is DryRunOperation . Otherwise, it is UnauthorizedOperation .
• 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

See: describePrincipalIdFormat smart constructor.

Instances

Eq DescribePrincipalIdFormat

Methods

(==) :: DescribePrincipalIdFormat -> DescribePrincipalIdFormat -> Bool

(/=) :: DescribePrincipalIdFormat -> DescribePrincipalIdFormat -> Bool

Data DescribePrincipalIdFormat

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribePrincipalIdFormat -> c DescribePrincipalIdFormat

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribePrincipalIdFormat

toConstr :: DescribePrincipalIdFormat -> Constr

dataTypeOf :: DescribePrincipalIdFormat -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribePrincipalIdFormat)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribePrincipalIdFormat)

gmapT :: (forall b. Data b => b -> b) -> DescribePrincipalIdFormat -> DescribePrincipalIdFormat

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribePrincipalIdFormat -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribePrincipalIdFormat -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribePrincipalIdFormat -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribePrincipalIdFormat -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribePrincipalIdFormat -> m DescribePrincipalIdFormat

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePrincipalIdFormat -> m DescribePrincipalIdFormat

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePrincipalIdFormat -> m DescribePrincipalIdFormat

Read DescribePrincipalIdFormat

Methods

readsPrec :: Int -> ReadS DescribePrincipalIdFormat

readList :: ReadS [DescribePrincipalIdFormat]

readPrec :: ReadPrec DescribePrincipalIdFormat

readListPrec :: ReadPrec [DescribePrincipalIdFormat]

Show DescribePrincipalIdFormat

Methods

showsPrec :: Int -> DescribePrincipalIdFormat -> ShowS

show :: DescribePrincipalIdFormat -> String

showList :: [DescribePrincipalIdFormat] -> ShowS

Generic DescribePrincipalIdFormat

Associated Types

type Rep DescribePrincipalIdFormat :: * -> *

Methods

from :: DescribePrincipalIdFormat -> Rep DescribePrincipalIdFormat x

to :: Rep DescribePrincipalIdFormat x -> DescribePrincipalIdFormat

Hashable DescribePrincipalIdFormat

Methods

hashWithSalt :: Int -> DescribePrincipalIdFormat -> Int

hash :: DescribePrincipalIdFormat -> Int

NFData DescribePrincipalIdFormat

Methods

rnf :: DescribePrincipalIdFormat -> ()

AWSRequest DescribePrincipalIdFormat

Associated Types

type Rs DescribePrincipalIdFormat :: *

Methods

request :: DescribePrincipalIdFormat -> Request DescribePrincipalIdFormat

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribePrincipalIdFormat -> ClientResponse -> m (Response DescribePrincipalIdFormat)

ToHeaders DescribePrincipalIdFormat

Methods

toHeaders :: DescribePrincipalIdFormat -> [Header]

ToPath DescribePrincipalIdFormat

Methods

toPath :: DescribePrincipalIdFormat -> ByteString

ToQuery DescribePrincipalIdFormat

Methods

toQuery :: DescribePrincipalIdFormat -> QueryString

type Rep DescribePrincipalIdFormat

type Rep DescribePrincipalIdFormat = D1 * (MetaData "DescribePrincipalIdFormat" "Network.AWS.EC2.DescribePrincipalIdFormat" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "DescribePrincipalIdFormat'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dpifResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_dpifNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dpifDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_dpifMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))

type Rs DescribePrincipalIdFormat

type Rs DescribePrincipalIdFormat = DescribePrincipalIdFormatResponse

Request Lenses

dpifResources :: Lens' DescribePrincipalIdFormat [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

dpifNextToken :: Lens' DescribePrincipalIdFormat (Maybe Text)

The token to request the next page of results.

dpifDryRun :: Lens' DescribePrincipalIdFormat (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 .

dpifMaxResults :: Lens' DescribePrincipalIdFormat (Maybe Int)

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

Arguments

:: Int

dpifrsResponseStatus

-> DescribePrincipalIdFormatResponse

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

See: describePrincipalIdFormatResponse smart constructor.

Instances

Eq DescribePrincipalIdFormatResponse

Methods

(==) :: DescribePrincipalIdFormatResponse -> DescribePrincipalIdFormatResponse -> Bool

(/=) :: DescribePrincipalIdFormatResponse -> DescribePrincipalIdFormatResponse -> Bool

Data DescribePrincipalIdFormatResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribePrincipalIdFormatResponse -> c DescribePrincipalIdFormatResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribePrincipalIdFormatResponse

toConstr :: DescribePrincipalIdFormatResponse -> Constr

dataTypeOf :: DescribePrincipalIdFormatResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribePrincipalIdFormatResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribePrincipalIdFormatResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribePrincipalIdFormatResponse -> DescribePrincipalIdFormatResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribePrincipalIdFormatResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribePrincipalIdFormatResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribePrincipalIdFormatResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribePrincipalIdFormatResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribePrincipalIdFormatResponse -> m DescribePrincipalIdFormatResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePrincipalIdFormatResponse -> m DescribePrincipalIdFormatResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribePrincipalIdFormatResponse -> m DescribePrincipalIdFormatResponse

Read DescribePrincipalIdFormatResponse

Methods

readsPrec :: Int -> ReadS DescribePrincipalIdFormatResponse

readList :: ReadS [DescribePrincipalIdFormatResponse]

readPrec :: ReadPrec DescribePrincipalIdFormatResponse

readListPrec :: ReadPrec [DescribePrincipalIdFormatResponse]

Show DescribePrincipalIdFormatResponse

Methods

showsPrec :: Int -> DescribePrincipalIdFormatResponse -> ShowS

show :: DescribePrincipalIdFormatResponse -> String

showList :: [DescribePrincipalIdFormatResponse] -> ShowS

Generic DescribePrincipalIdFormatResponse

Associated Types

type Rep DescribePrincipalIdFormatResponse :: * -> *

Methods

from :: DescribePrincipalIdFormatResponse -> Rep DescribePrincipalIdFormatResponse x

to :: Rep DescribePrincipalIdFormatResponse x -> DescribePrincipalIdFormatResponse

NFData DescribePrincipalIdFormatResponse

Methods

rnf :: DescribePrincipalIdFormatResponse -> ()

type Rep DescribePrincipalIdFormatResponse

type Rep DescribePrincipalIdFormatResponse = D1 * (MetaData "DescribePrincipalIdFormatResponse" "Network.AWS.EC2.DescribePrincipalIdFormat" "amazonka-ec2-1.6.0-Kkew7Kpgof6EYi20Z0WOzs" False) (C1 * (MetaCons "DescribePrincipalIdFormatResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dpifrsPrincipals") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PrincipalIdFormat]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dpifrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dpifrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dpifrsPrincipals :: Lens' DescribePrincipalIdFormatResponse [PrincipalIdFormat]

Information about the ID format settings for the ARN.

dpifrsNextToken :: Lens' DescribePrincipalIdFormatResponse (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.

dpifrsResponseStatus :: Lens' DescribePrincipalIdFormatResponse Int

• - | The response status code.