Method: Aws::IAM::Client#list_account_aliases

Defined in:

lib/aws-sdk-iam/client.rb

#list_account_aliases(params = {}) ⇒ Types::ListAccountAliasesResponse

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 [Creating, deleting, and listing an Amazon Web Services account alias] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html#CreateAccountAlias

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list account aliases

# The following command lists the aliases for the current account.

resp = client.list_account_aliases({
})

resp.to_h outputs the following:
{
  account_aliases: [
    "exmaple-corporation", 
  ], 
}

Request syntax with placeholder values

resp = client.list_account_aliases({
  marker: "markerType",
  max_items: 1,
})

Response structure

resp.account_aliases #=> Array
resp.account_aliases[0] #=> String
resp.is_truncated #=> Boolean
resp.marker #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :marker (String) —

  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.

• :max_items (Integer) —

  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

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

Returns:

• (Types::ListAccountAliasesResponse) —

  Returns a response object which responds to the following methods:

  • #account_aliases => Array<String>

  • #is_truncated => Boolean

  • #marker => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-iam/client.rb', line 6844

def list_account_aliases(params = {}, options = {})
  req = build_request(:list_account_aliases, params)
  req.send_request(options)
end