IAM Roles Anywhere

2026/11/19 - IAM Roles Anywhere - 9 updated api methods

Changes  Adds the tipConfiguration field to profiles to turn on trusted identity propagation, which adds the identity from an X.509 certificate to sessions as origin identity condition keys.

CreateProfile (updated) Link ¶
Changes (request, response)
Request
{'tipConfiguration': {'status': 'ENABLED | DISABLED',
                      'subjectSource': 'x509SAN/URI | x509Subject/CN',
                      'subjectType': 'user | workload'}}
Response
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile.

See also: AWS API Documentation

Request Syntax

client.create_profile(
    name='string',
    requireInstanceProperties=True|False,
    sessionPolicy='string',
    roleArns=[
        'string',
    ],
    managedPolicyArns=[
        'string',
    ],
    durationSeconds=123,
    enabled=True|False,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    acceptRoleSessionName=True|False,
    aliasName='string',
    tipConfiguration={
        'status': 'ENABLED'|'DISABLED',
        'subjectType': 'user'|'workload',
        'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
    }
)
type name:

string

param name:

[REQUIRED]

The name of the profile.

type requireInstanceProperties:

boolean

param requireInstanceProperties:

Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

type sessionPolicy:

string

param sessionPolicy:

A session policy that applies to the trust boundary of the vended session credentials.

type roleArns:

list

param roleArns:

[REQUIRED]

A list of IAM roles that this profile can assume in a temporary credential request.

  • (string) --

type managedPolicyArns:

list

param managedPolicyArns:

A list of managed policy ARNs that apply to the vended session credentials.

  • (string) --

type durationSeconds:

integer

param durationSeconds:

Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

type enabled:

boolean

param enabled:

Specifies whether the profile is enabled.

type tags:

list

param tags:

The tags to attach to the profile.

  • (dict) --

    A label that consists of a key and value you define.

    • key (string) -- [REQUIRED]

      The tag key.

    • value (string) -- [REQUIRED]

      The tag value.

type acceptRoleSessionName:

boolean

param acceptRoleSessionName:

Used to determine if a custom role session name will be accepted in a temporary credential request.

type aliasName:

string

param aliasName:

An alias for the profile. When you set an alias, the response includes the alias ARN of the profile in aliasArn.

An alias name contains 1 to 256 characters. It must begin with a letter (A-Z or a-z). It can contain only letters (A-Z and a-z), numbers (0-9), underscores (_), hyphens (-), and forward slashes (/). A forward slash can appear only between two other characters, so an alias name can't end with a forward slash or contain two in a row. Alias names that begin with aws/, in any combination of uppercase and lowercase letters, are reserved. Alias names are case sensitive.

The alias name must be unique among resources of the same type in your account and Region. If another resource of the same type already has the alias, the request fails with a ValidationException. An invalid or reserved alias name also causes a ValidationException.

If you omit this parameter or specify an empty string, the resource is created without an alias.

type tipConfiguration:

dict

param tipConfiguration:

The trusted identity propagation (TIP) settings for the profile. When you enable TIP, sessions from the profile include the identity from the certificate in aws:OriginIdentity condition keys.

If you omit this parameter, the profile doesn't use TIP.

  • status (string) -- [REQUIRED]

    Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

    • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

    • DISABLED – Sessions from the profile don't include these keys.

  • subjectType (string) --

    Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

    • workload – The certificates identify workloads.

    • user – The certificates identify people.

    Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

  • subjectSource (string) --

    The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

    • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

    • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

    The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

DeleteAttributeMapping (updated) Link ¶
Changes (response)
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Delete an entry from the attribute mapping rules enforced by a given profile.

See also: AWS API Documentation

Request Syntax

client.delete_attribute_mapping(
    profileId='string',
    certificateField='x509Subject'|'x509Issuer'|'x509SAN',
    specifiers=[
        'string',
    ]
)
type profileId:

string

param profileId:

[REQUIRED]

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

type certificateField:

string

param certificateField:

[REQUIRED]

Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

type specifiers:

list

param specifiers:

A list of specifiers of a certificate field; for example, CN, OU, UID from a Subject.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

DeleteProfile (updated) Link ¶
Changes (response)
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Deletes a profile.

Required permissions: rolesanywhere:DeleteProfile.

See also: AWS API Documentation

Request Syntax

client.delete_profile(
    profileId='string'
)
type profileId:

string

param profileId:

[REQUIRED]

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

DisableProfile (updated) Link ¶
Changes (response)
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Disables a profile. When disabled, temporary credential requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

See also: AWS API Documentation

Request Syntax

client.disable_profile(
    profileId='string'
)
type profileId:

string

param profileId:

[REQUIRED]

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

EnableProfile (updated) Link ¶
Changes (response)
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Enables temporary credential requests for a profile.

Required permissions: rolesanywhere:EnableProfile.

See also: AWS API Documentation

Request Syntax

client.enable_profile(
    profileId='string'
)
type profileId:

string

param profileId:

[REQUIRED]

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

GetProfile (updated) Link ¶
Changes (response)
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Gets a profile.

Required permissions: rolesanywhere:GetProfile.

See also: AWS API Documentation

Request Syntax

client.get_profile(
    profileId='string'
)
type profileId:

string

param profileId:

[REQUIRED]

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

ListProfiles (updated) Link ¶
Changes (response)
{'profiles': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                   'subjectSource': 'x509SAN/URI | '
                                                    'x509Subject/CN',
                                   'subjectType': 'user | workload'}}}

Lists all profiles in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListProfiles.

See also: AWS API Documentation

Request Syntax

client.list_profiles(
    nextToken='string',
    pageSize=123
)
type nextToken:

string

param nextToken:

A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.

type pageSize:

integer

param pageSize:

The number of resources in the paginated list.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'profiles': [
        {
            'profileId': 'string',
            'profileArn': 'string',
            'name': 'string',
            'requireInstanceProperties': True|False,
            'enabled': True|False,
            'createdBy': 'string',
            'sessionPolicy': 'string',
            'roleArns': [
                'string',
            ],
            'managedPolicyArns': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'durationSeconds': 123,
            'acceptRoleSessionName': True|False,
            'attributeMappings': [
                {
                    'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                    'mappingRules': [
                        {
                            'specifier': 'string'
                        },
                    ]
                },
            ],
            'aliasName': 'string',
            'aliasArn': 'string',
            'tipConfiguration': {
                'status': 'ENABLED'|'DISABLED',
                'subjectType': 'user'|'workload',
                'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
            },
            'previousAliasName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value.

    • profiles (list) --

      A list of profiles.

      • (dict) --

        The state of the profile after a read or write operation.

        • profileId (string) --

          The unique identifier of the profile.

        • profileArn (string) --

          The ARN of the profile.

        • name (string) --

          The name of the profile.

        • requireInstanceProperties (boolean) --

          Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

        • enabled (boolean) --

          Indicates whether the profile is enabled.

        • createdBy (string) --

          The Amazon Web Services account that created the profile.

        • sessionPolicy (string) --

          A session policy that applies to the trust boundary of the vended session credentials.

        • roleArns (list) --

          A list of IAM roles that this profile can assume in a temporary credential request.

          • (string) --

        • managedPolicyArns (list) --

          A list of managed policy ARNs that apply to the vended session credentials.

          • (string) --

        • createdAt (datetime) --

          The ISO-8601 timestamp when the profile was created.

        • updatedAt (datetime) --

          The ISO-8601 timestamp when the profile was last updated.

        • durationSeconds (integer) --

          Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

        • acceptRoleSessionName (boolean) --

          Used to determine if a custom role session name will be accepted in a temporary credential request.

        • attributeMappings (list) --

          A mapping applied to the authenticating end-entity certificate.

          • (dict) --

            A mapping applied to the authenticating end-entity certificate.

            • certificateField (string) --

              Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

            • mappingRules (list) --

              A list of mapping entries for every supported specifier or sub-field.

              • (dict) --

                A single mapping entry for each supported specifier or sub-field.

                • specifier (string) --

                  Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

        • aliasName (string) --

          The alias of the profile. Present only if the profile has an alias.

        • aliasArn (string) --

          The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

          You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

        • tipConfiguration (dict) --

          The trusted identity propagation (TIP) settings of the profile.

          • status (string) --

            Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

            • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

            • DISABLED – Sessions from the profile don't include these keys.

          • subjectType (string) --

            Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

            • workload – The certificates identify workloads.

            • user – The certificates identify people.

            Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

          • subjectSource (string) --

            The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

            • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

            • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

            The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

        • previousAliasName (string) --

          The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

PutAttributeMapping (updated) Link ¶
Changes (response)
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.

See also: AWS API Documentation

Request Syntax

client.put_attribute_mapping(
    profileId='string',
    certificateField='x509Subject'|'x509Issuer'|'x509SAN',
    mappingRules=[
        {
            'specifier': 'string'
        },
    ]
)
type profileId:

string

param profileId:

[REQUIRED]

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

type certificateField:

string

param certificateField:

[REQUIRED]

Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

type mappingRules:

list

param mappingRules:

[REQUIRED]

A list of mapping entries for every supported specifier or sub-field.

  • (dict) --

    A single mapping entry for each supported specifier or sub-field.

    • specifier (string) -- [REQUIRED]

      Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.

UpdateProfile (updated) Link ¶
Changes (request, response)
Request
{'tipConfiguration': {'status': 'ENABLED | DISABLED',
                      'subjectSource': 'x509SAN/URI | x509Subject/CN',
                      'subjectType': 'user | workload'}}
Response
{'profile': {'tipConfiguration': {'status': 'ENABLED | DISABLED',
                                  'subjectSource': 'x509SAN/URI | '
                                                   'x509Subject/CN',
                                  'subjectType': 'user | workload'}}}

Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:UpdateProfile.

See also: AWS API Documentation

Request Syntax

client.update_profile(
    profileId='string',
    name='string',
    sessionPolicy='string',
    roleArns=[
        'string',
    ],
    managedPolicyArns=[
        'string',
    ],
    durationSeconds=123,
    acceptRoleSessionName=True|False,
    aliasName='string',
    tipConfiguration={
        'status': 'ENABLED'|'DISABLED',
        'subjectType': 'user'|'workload',
        'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
    }
)
type profileId:

string

param profileId:

[REQUIRED]

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

type name:

string

param name:

The name of the profile.

type sessionPolicy:

string

param sessionPolicy:

A session policy that applies to the trust boundary of the vended session credentials.

type roleArns:

list

param roleArns:

A list of IAM roles that this profile can assume in a temporary credential request.

  • (string) --

type managedPolicyArns:

list

param managedPolicyArns:

A list of managed policy ARNs that apply to the vended session credentials.

  • (string) --

type durationSeconds:

integer

param durationSeconds:

Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

type acceptRoleSessionName:

boolean

param acceptRoleSessionName:

Used to determine if a custom role session name will be accepted in a temporary credential request.

type aliasName:

string

param aliasName:

The alias for the profile.

You can use this parameter in the following ways:

  • To set or change the alias, specify the new alias name. After the change, the previous alias ARN no longer identifies the resource. You can then assign the previous alias to another resource of the same type. A change can take a short time to take effect for requests that use an alias ARN.

  • To remove the alias, specify an empty string.

  • To keep the current alias, omit this parameter.

An alias name contains 1 to 256 characters. It must begin with a letter (A-Z or a-z). It can contain only letters (A-Z and a-z), numbers (0-9), underscores (_), hyphens (-), and forward slashes (/). A forward slash can appear only between two other characters, so an alias name can't end with a forward slash or contain two in a row. Alias names that begin with aws/, in any combination of uppercase and lowercase letters, are reserved. Alias names are case sensitive.

The alias name must be unique among resources of the same type in your account and Region. If another resource of the same type already has the alias, the request fails with a ValidationException. An invalid or reserved alias name also causes a ValidationException.

type tipConfiguration:

dict

param tipConfiguration:

The trusted identity propagation (TIP) settings for the profile. The settings that you specify replace the current settings, and a field that you omit returns to its default. If you omit this parameter, the TIP settings don't change.

  • status (string) -- [REQUIRED]

    Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

    • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

    • DISABLED – Sessions from the profile don't include these keys.

  • subjectType (string) --

    Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

    • workload – The certificates identify workloads.

    • user – The certificates identify people.

    Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

  • subjectSource (string) --

    The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

    • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

    • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

    The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

rtype:

dict

returns:

Response Syntax

{
    'profile': {
        'profileId': 'string',
        'profileArn': 'string',
        'name': 'string',
        'requireInstanceProperties': True|False,
        'enabled': True|False,
        'createdBy': 'string',
        'sessionPolicy': 'string',
        'roleArns': [
            'string',
        ],
        'managedPolicyArns': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'durationSeconds': 123,
        'acceptRoleSessionName': True|False,
        'attributeMappings': [
            {
                'certificateField': 'x509Subject'|'x509Issuer'|'x509SAN',
                'mappingRules': [
                    {
                        'specifier': 'string'
                    },
                ]
            },
        ],
        'aliasName': 'string',
        'aliasArn': 'string',
        'tipConfiguration': {
            'status': 'ENABLED'|'DISABLED',
            'subjectType': 'user'|'workload',
            'subjectSource': 'x509SAN/URI'|'x509Subject/CN'
        },
        'previousAliasName': 'string'
    }
}

Response Structure

  • (dict) --

    • profile (dict) --

      The state of the profile after a read or write operation.

      • profileId (string) --

        The unique identifier of the profile.

      • profileArn (string) --

        The ARN of the profile.

      • name (string) --

        The name of the profile.

      • requireInstanceProperties (boolean) --

        Unused, saved for future use. Will likely specify whether instance properties are required in temporary credential requests with this profile.

      • enabled (boolean) --

        Indicates whether the profile is enabled.

      • createdBy (string) --

        The Amazon Web Services account that created the profile.

      • sessionPolicy (string) --

        A session policy that applies to the trust boundary of the vended session credentials.

      • roleArns (list) --

        A list of IAM roles that this profile can assume in a temporary credential request.

        • (string) --

      • managedPolicyArns (list) --

        A list of managed policy ARNs that apply to the vended session credentials.

        • (string) --

      • createdAt (datetime) --

        The ISO-8601 timestamp when the profile was created.

      • updatedAt (datetime) --

        The ISO-8601 timestamp when the profile was last updated.

      • durationSeconds (integer) --

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • acceptRoleSessionName (boolean) --

        Used to determine if a custom role session name will be accepted in a temporary credential request.

      • attributeMappings (list) --

        A mapping applied to the authenticating end-entity certificate.

        • (dict) --

          A mapping applied to the authenticating end-entity certificate.

          • certificateField (string) --

            Fields (x509Subject, x509Issuer and x509SAN) within X.509 certificates.

          • mappingRules (list) --

            A list of mapping entries for every supported specifier or sub-field.

            • (dict) --

              A single mapping entry for each supported specifier or sub-field.

              • specifier (string) --

                Specifier within a certificate field, such as CN, OU, or UID from the Subject field.

      • aliasName (string) --

        The alias of the profile. Present only if the profile has an alias.

      • aliasArn (string) --

        The alias ARN of the profile, in the form ``arn:partition:rolesanywhere:region:account:alias/profile/alias-name ``. Present only if the profile has an alias.

        You can use the alias ARN in place of the resource ID or ARN in the request parameters whose descriptions say that they accept an alias ARN. Don't use the alias ARN in Identity and Access Management (IAM) policies. A policy statement that names an alias ARN doesn't apply to the resource that holds the alias. Write policies with the ARN that contains the resource ID instead.

      • tipConfiguration (dict) --

        The trusted identity propagation (TIP) settings of the profile.

        • status (string) --

          Specifies whether you use trusted identity propagation (TIP) for the profile. This field supports the following values:

          • ENABLED – Sessions from the profile include the aws:OriginIdentity condition keys.

          • DISABLED – Sessions from the profile don't include these keys.

        • subjectType (string) --

          Specifies whether the certificates for the profile identify workloads or people. This field supports the following values:

          • workload – The certificates identify workloads.

          • user – The certificates identify people.

          Sessions include the value in aws:OriginIdentity/SubjectType. If you omit this field, sessions don't include that key.

        • subjectSource (string) --

          The certificate field whose value becomes the subject, aws:OriginIdentity/Subject. This field supports the following values:

          • x509Subject/CN (default) – The common name (CN) in the certificate's Subject.

          • x509SAN/URI – The first URI in the certificate's Subject Alternative Name (SAN) extension.

          The profile's attribute mappings must include a rule for this field, and the default attribute mappings include one for each value. If the certificate has no value for the field, CreateSession denies the request.

      • previousAliasName (string) --

        The alias that the resource had before the update request. IAM Roles Anywhere returns this value only in the response to an update request that changed or removed an existing alias. It isn't returned when the alias was unchanged, when the resource had no alias before the request, or by other operations.