Managing IAM account aliases - Boto3 1.34.74 documentation

This Python example shows you how to manage aliases for your AWS account ID.

The scenario#

If you want the URL for your sign-in page to contain your company name or other friendly identifier instead of your AWS account ID, you can create an alias for your AWS account ID. If you create an AWS account alias, your sign-in page URL changes to incorporate the alias.

In this example, Python code is used to create and manage IAM account aliases. The code uses the AWS SDK for Python to manage IAM access keys using these methods of the IAM client class:

For more information about IAM account aliases, see Your AWS Account ID and Its Aliasin the IAM User Guide.

All the example code for the Amazon Web Services (AWS) SDK for Python is available here on GitHub.

Prerequisite tasks#

To set up and run this example, you must first configure your AWS credentials, as described in Quickstart.

Create an account alias#

Create an alias for your AWS account. For information about using an AWS account alias, seeUsing an Alias for Your AWS Account IDin the IAM User Guide.

The example below shows how to:

Example#

import boto3# Create IAM clientiam = boto3.client('iam')# Create an account aliasiam.create_account_alias( AccountAlias='ALIAS')

List an account alias#

List the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account IDin the IAM User Guide.

The example below shows how to:

For more information about paginators see, Paginators

Example#

import boto3# Create IAM clientiam = boto3.client('iam')# List account aliases through the pagination interfacepaginator = iam.get_paginator('list_account_aliases')for response in paginator.paginate(): print(response['AccountAliases'])

Delete an account alias#

Delete the specified AWS account alias. For information about using an AWS account alias, seeUsing an Alias for Your AWS Account IDin the IAM User Guide.

The example below shows how to:

Example#

import boto3# Create IAM clientiam = boto3.client('iam')# Delete an account aliasiam.delete_account_alias( AccountAlias='ALIAS')