IAM / Client / create_role

create_role#

IAM.Client.create_role(**kwargs)#

Creates a new role for your Amazon Web Services account.

For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide.

Request Syntax

response = client.create_role(
    Path='string',
    RoleName='string',
    AssumeRolePolicyDocument='string',
    Description='string',
    MaxSessionDuration=123,
    PermissionsBoundary='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Path (string) –
The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \u0021) through the DEL character ( \u007F), including most punctuation characters, digits, and upper and lowercased letters.
RoleName (string) –
[REQUIRED]

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
AssumeRolePolicyDocument (string) –
[REQUIRED]

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character ( \u0020) through the end of the ASCII character range
- The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
- The special characters tab ( \u0009), line feed ( \u000A), and carriage return ( \u000D)
Upon success, the response includes the same trust policy in JSON format.
Description (string) – A description of the role.
MaxSessionDuration (integer) –
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don’t specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
PermissionsBoundary (string) –
The ARN of the managed policy that is used to set the permissions boundary for the role.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

For more information about policy types, see Policy types in the IAM User Guide.
Tags (list) –
A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Note
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
- (dict) –
  
  A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
  - Key (string) – [REQUIRED]
    
    The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.
  - Value (string) – [REQUIRED]
    
    The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
    
    Note
    Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

Return type:

dict

Returns:

Response Syntax

{
    'Role': {
        'Path': 'string',
        'RoleName': 'string',
        'RoleId': 'string',
        'Arn': 'string',
        'CreateDate': datetime(2015, 1, 1),
        'AssumeRolePolicyDocument': 'string',
        'Description': 'string',
        'MaxSessionDuration': 123,
        'PermissionsBoundary': {
            'PermissionsBoundaryType': 'PermissionsBoundaryPolicy',
            'PermissionsBoundaryArn': 'string'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RoleLastUsed': {
            'LastUsedDate': datetime(2015, 1, 1),
            'Region': 'string'
        }
    }
}

Response Structure

(dict) –

Contains the response to a successful CreateRole request.
- Role (dict) –
  
  A structure containing details about the new role.
  - Path (string) –
    
    The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
  - RoleName (string) –
    
    The friendly name that identifies the role.
  - RoleId (string) –
    
    The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.
  - CreateDate (datetime) –
    
    The date and time, in ISO 8601 date-time format, when the role was created.
  - AssumeRolePolicyDocument (string) –
    
    The policy that grants an entity permission to assume the role.
  - Description (string) –
    
    A description of the role that you provide.
  - MaxSessionDuration (integer) –
    
    The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
  - PermissionsBoundary (dict) –
    
    The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    - PermissionsBoundaryType (string) –
      
      The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.
    - PermissionsBoundaryArn (string) –
      
      The ARN of the policy used to set the permissions boundary for the user or role.
  - Tags (list) –
    
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    - (dict) –
      
      A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
      - Key (string) –
        
        The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.
      - Value (string) –
        
        The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
        
        Note
        Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
  - RoleLastUsed (dict) –
    
    Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
    - LastUsedDate (datetime) –
      
      The date and time, in ISO 8601 date-time format that the role was last used.
      
      This field is null if the role has not been used within the IAM tracking period. For more information about the tracking period, see Regions where data is tracked in the IAM User Guide.
    - Region (string) –
      
      The name of the Amazon Web Services Region in which the role was last used.

Exceptions

IAM.Client.exceptions.LimitExceededException
IAM.Client.exceptions.InvalidInputException
IAM.Client.exceptions.EntityAlreadyExistsException
IAM.Client.exceptions.MalformedPolicyDocumentException
IAM.Client.exceptions.ConcurrentModificationException
IAM.Client.exceptions.ServiceFailureException

Examples

The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a string. Upon success, the response includes the same policy as a URL-encoded JSON string.

response = client.create_role(
    AssumeRolePolicyDocument='<Stringified-JSON>',
    Path='/',
    RoleName='Test-Role',
)

print(response)

Expected Output:

{
    'Role': {
        'Arn': 'arn:aws:iam::123456789012:role/Test-Role',
        'AssumeRolePolicyDocument': '<URL-encoded-JSON>',
        'CreateDate': datetime(2013, 6, 7, 20, 43, 32, 4, 158, 0),
        'Path': '/',
        'RoleId': 'AKIAIOSFODNN7EXAMPLE',
        'RoleName': 'Test-Role',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}