Amazonka.IAM.ListAccountAliases

Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide.

This operation returns paginated results.

Creating a Request

data ListAccountAliases

See: newListAccountAliases smart constructor.

Constructors

ListAccountAliases'

Fields

• marker :: Maybe Text

  Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

• maxItems :: Maybe Natural

  Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

  If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Instances

ToHeaders ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

toHeaders :: ListAccountAliases -> [Header]

ToPath ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

toPath :: ListAccountAliases -> ByteString

ToQuery ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

toQuery :: ListAccountAliases -> QueryString

AWSPager ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

page :: ListAccountAliases -> AWSResponse ListAccountAliases -> Maybe ListAccountAliases

AWSRequest ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Associated Types

type AWSResponse ListAccountAliases

Methods

request :: (Service -> Service) -> ListAccountAliases -> Request ListAccountAliases

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAccountAliases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAccountAliases)))

Generic ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Associated Types

type Rep ListAccountAliases :: Type -> Type

Methods

from :: ListAccountAliases -> Rep ListAccountAliases x

to :: Rep ListAccountAliases x -> ListAccountAliases

Read ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

readsPrec :: Int -> ReadS ListAccountAliases

readList :: ReadS [ListAccountAliases]

readPrec :: ReadPrec ListAccountAliases

readListPrec :: ReadPrec [ListAccountAliases]

Show ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

showsPrec :: Int -> ListAccountAliases -> ShowS

show :: ListAccountAliases -> String

showList :: [ListAccountAliases] -> ShowS

NFData ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

rnf :: ListAccountAliases -> ()

Eq ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

(==) :: ListAccountAliases -> ListAccountAliases -> Bool

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

Hashable ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

Methods

hashWithSalt :: Int -> ListAccountAliases -> Int

hash :: ListAccountAliases -> Int

type AWSResponse ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

type AWSResponse ListAccountAliases = ListAccountAliasesResponse

type Rep ListAccountAliases

Defined in Amazonka.IAM.ListAccountAliases

type Rep ListAccountAliases = D1 ('MetaData "ListAccountAliases" "Amazonka.IAM.ListAccountAliases" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListAccountAliases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newListAccountAliases :: ListAccountAliases

Create a value of ListAccountAliases 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:

ListAccountAliases, listAccountAliases_marker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

$sel:maxItems:ListAccountAliases', listAccountAliases_maxItems - Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Request Lenses

listAccountAliases_marker :: Lens' ListAccountAliases (Maybe Text)

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listAccountAliases_maxItems :: Lens' ListAccountAliases (Maybe Natural)

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Destructuring the Response

data ListAccountAliasesResponse

Contains the response to a successful ListAccountAliases request.

See: newListAccountAliasesResponse smart constructor.

Constructors

ListAccountAliasesResponse'

Fields

• isTruncated :: Maybe Bool

  A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

• marker :: Maybe Text

  When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

• httpStatus :: Int

  The response's http status code.

• accountAliases :: [Text]

  A list of aliases associated with the account. Amazon Web Services supports only one alias per account.

Instances

Generic ListAccountAliasesResponse

Defined in Amazonka.IAM.ListAccountAliases

Associated Types

type Rep ListAccountAliasesResponse :: Type -> Type

Methods

from :: ListAccountAliasesResponse -> Rep ListAccountAliasesResponse x

to :: Rep ListAccountAliasesResponse x -> ListAccountAliasesResponse

Read ListAccountAliasesResponse

Defined in Amazonka.IAM.ListAccountAliases

Methods

readsPrec :: Int -> ReadS ListAccountAliasesResponse

readList :: ReadS [ListAccountAliasesResponse]

readPrec :: ReadPrec ListAccountAliasesResponse

readListPrec :: ReadPrec [ListAccountAliasesResponse]

Show ListAccountAliasesResponse

Defined in Amazonka.IAM.ListAccountAliases

Methods

showsPrec :: Int -> ListAccountAliasesResponse -> ShowS

show :: ListAccountAliasesResponse -> String

showList :: [ListAccountAliasesResponse] -> ShowS

NFData ListAccountAliasesResponse

Defined in Amazonka.IAM.ListAccountAliases

Methods

rnf :: ListAccountAliasesResponse -> ()

Eq ListAccountAliasesResponse

Defined in Amazonka.IAM.ListAccountAliases

Methods

(==) :: ListAccountAliasesResponse -> ListAccountAliasesResponse -> Bool

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

type Rep ListAccountAliasesResponse

Defined in Amazonka.IAM.ListAccountAliases

type Rep ListAccountAliasesResponse = D1 ('MetaData "ListAccountAliasesResponse" "Amazonka.IAM.ListAccountAliases" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListAccountAliasesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "accountAliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListAccountAliasesResponse

Arguments

:: Int

$sel:httpStatus:ListAccountAliasesResponse'

-> ListAccountAliasesResponse

Create a value of ListAccountAliasesResponse 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:

ListAccountAliasesResponse, listAccountAliasesResponse_isTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

ListAccountAliases, listAccountAliasesResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:httpStatus:ListAccountAliasesResponse', listAccountAliasesResponse_httpStatus - The response's http status code.

$sel:accountAliases:ListAccountAliasesResponse', listAccountAliasesResponse_accountAliases - A list of aliases associated with the account. Amazon Web Services supports only one alias per account.

Response Lenses

listAccountAliasesResponse_isTruncated :: Lens' ListAccountAliasesResponse (Maybe Bool)

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listAccountAliasesResponse_marker :: Lens' ListAccountAliasesResponse (Maybe Text)

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listAccountAliasesResponse_httpStatus :: Lens' ListAccountAliasesResponse Int

The response's http status code.

listAccountAliasesResponse_accountAliases :: Lens' ListAccountAliasesResponse [Text]

A list of aliases associated with the account. Amazon Web Services supports only one alias per account.