SSOAdmin

Client

class SSOAdmin.Client

A low-level client representing AWS Single Sign-On Admin (SSO Admin)

client = session.create_client('sso-admin')

These are the available methods:

attach_customer_managed_policy_reference_to_permission_set(**kwargs)

Attaches the specified customer managed policy to the specified PermissionSet .

See also: AWS API Documentation

Request Syntax

response = client.attach_customer_managed_policy_reference_to_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    CustomerManagedPolicyReference={
        'Name': 'string',
        'Path': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet .

  • CustomerManagedPolicyReference (dict) --

    [REQUIRED]

    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

    • Name (string) -- [REQUIRED]

      The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

    • Path (string) --

      The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the Identity and Access Management User Guide .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

attach_managed_policy_to_permission_set(**kwargs)

Attaches an Amazon Web Services managed policy ARN to a permission set.

Note

If the permission set is already referenced by one or more account assignments, you will need to call `` ProvisionPermissionSet `` after this operation. Calling ProvisionPermissionSet applies the corresponding IAM policy updates to all assigned accounts.

See also: AWS API Documentation

Request Syntax

response = client.attach_managed_policy_to_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    ManagedPolicyArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet that the managed policy should be attached to.

  • ManagedPolicyArn (string) --

    [REQUIRED]

    The Amazon Web Services managed policy ARN to be attached to a permission set.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_account_assignment(**kwargs)

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.

Note

The term principal here refers to a user or group that is defined in Amazon Web Services SSO.

Note

As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in Amazon Web Services SSO. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call `` ProvisionPermissionSet `` to make these updates.

See also: AWS API Documentation

Request Syntax

response = client.create_account_assignment(
    InstanceArn='string',
    TargetId='string',
    TargetType='AWS_ACCOUNT',
    PermissionSetArn='string',
    PrincipalType='USER'|'GROUP',
    PrincipalId='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • TargetId (string) --

    [REQUIRED]

    TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

  • TargetType (string) --

    [REQUIRED]

    The entity type for which the assignment will be created.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set that the admin wants to grant the principal access to.

  • PrincipalType (string) --

    [REQUIRED]

    The entity type for which the assignment will be created.

  • PrincipalId (string) --

    [REQUIRED]

    An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentCreationStatus': {
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'RequestId': 'string',
        'FailureReason': 'string',
        'TargetId': 'string',
        'TargetType': 'AWS_ACCOUNT',
        'PermissionSetArn': 'string',
        'PrincipalType': 'USER'|'GROUP',
        'PrincipalId': 'string',
        'CreatedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • AccountAssignmentCreationStatus (dict) --

      The status object for the account assignment creation operation.

      • Status (string) --

        The status of the permission set provisioning process.

      • RequestId (string) --

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • FailureReason (string) --

        The message that contains an error or exception in case of an operation failure.

      • TargetId (string) --

        TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

      • TargetType (string) --

        The entity type for which the assignment will be created.

      • PermissionSetArn (string) --

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • PrincipalType (string) --

        The entity type for which the assignment will be created.

      • PrincipalId (string) --

        An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

      • CreatedDate (datetime) --

        The date that the permission set was created.

Exceptions

create_instance_access_control_attribute_configuration(**kwargs)

Enables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_instance_access_control_attribute_configuration(
    InstanceArn='string',
    InstanceAccessControlAttributeConfiguration={
        'AccessControlAttributes': [
            {
                'Key': 'string',
                'Value': {
                    'Source': [
                        'string',
                    ]
                }
            },
        ]
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • InstanceAccessControlAttributeConfiguration (dict) --

    [REQUIRED]

    Specifies the Amazon Web Services SSO identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the Amazon Web Services SSO identity store. If a SAML assertion passes any of these attributes, Amazon Web Services SSO will replace the attribute value with the value from the Amazon Web Services SSO identity store.

    • AccessControlAttributes (list) -- [REQUIRED]

      Lists the attributes that are configured for ABAC in the specified Amazon Web Services SSO instance.

      • (dict) --

        These are Amazon Web Services SSO identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your Amazon Web Services resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes , Amazon Web Services SSO passes the attribute values of the authenticated user into IAM for use in policy evaluation.

        • Key (string) -- [REQUIRED]

          The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in Amazon Web Services SSO.

        • Value (dict) -- [REQUIRED]

          The value used for mapping a specified attribute to an identity source.

          • Source (list) -- [REQUIRED]

            The identity source to use when mapping a specified attribute to Amazon Web Services SSO.

            • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

create_permission_set(**kwargs)

Creates a permission set within a specified Amazon Web Services SSO instance.

Note

To grant users and groups access to Amazon Web Services account resources, use `` CreateAccountAssignment `` .

See also: AWS API Documentation

Request Syntax

response = client.create_permission_set(
    Name='string',
    Description='string',
    InstanceArn='string',
    SessionDuration='string',
    RelayState='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the PermissionSet .

  • Description (string) -- The description of the PermissionSet .
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • SessionDuration (string) -- The length of time that the application user sessions are valid in the ISO-8601 standard.
  • RelayState (string) -- Used to redirect users within the application during the federation authentication process.
  • Tags (list) --

    The tags to attach to the new PermissionSet .

    • (dict) --

      A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that Amazon Web Services SSO creates in Amazon Web Services accounts.

      • Key (string) -- [REQUIRED]

        The key for the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'PermissionSet': {
        'Name': 'string',
        'PermissionSetArn': 'string',
        'Description': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'SessionDuration': 'string',
        'RelayState': 'string'
    }
}

Response Structure

  • (dict) --

    • PermissionSet (dict) --

      Defines the level of access on an Amazon Web Services account.

      • Name (string) --

        The name of the permission set.

      • PermissionSetArn (string) --

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • Description (string) --

        The description of the PermissionSet .

      • CreatedDate (datetime) --

        The date that the permission set was created.

      • SessionDuration (string) --

        The length of time that the application user sessions are valid for in the ISO-8601 standard.

      • RelayState (string) --

        Used to redirect users within the application during the federation authentication process.

Exceptions

delete_account_assignment(**kwargs)

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.

See also: AWS API Documentation

Request Syntax

response = client.delete_account_assignment(
    InstanceArn='string',
    TargetId='string',
    TargetType='AWS_ACCOUNT',
    PermissionSetArn='string',
    PrincipalType='USER'|'GROUP',
    PrincipalId='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • TargetId (string) --

    [REQUIRED]

    TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

  • TargetType (string) --

    [REQUIRED]

    The entity type for which the assignment will be deleted.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set that will be used to remove access.

  • PrincipalType (string) --

    [REQUIRED]

    The entity type for which the assignment will be deleted.

  • PrincipalId (string) --

    [REQUIRED]

    An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentDeletionStatus': {
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'RequestId': 'string',
        'FailureReason': 'string',
        'TargetId': 'string',
        'TargetType': 'AWS_ACCOUNT',
        'PermissionSetArn': 'string',
        'PrincipalType': 'USER'|'GROUP',
        'PrincipalId': 'string',
        'CreatedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • AccountAssignmentDeletionStatus (dict) --

      The status object for the account assignment deletion operation.

      • Status (string) --

        The status of the permission set provisioning process.

      • RequestId (string) --

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • FailureReason (string) --

        The message that contains an error or exception in case of an operation failure.

      • TargetId (string) --

        TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

      • TargetType (string) --

        The entity type for which the assignment will be created.

      • PermissionSetArn (string) --

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • PrincipalType (string) --

        The entity type for which the assignment will be created.

      • PrincipalId (string) --

        An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

      • CreatedDate (datetime) --

        The date that the permission set was created.

Exceptions

delete_inline_policy_from_permission_set(**kwargs)

Deletes the inline policy from a specified permission set.

See also: AWS API Documentation

Request Syntax

response = client.delete_inline_policy_from_permission_set(
    InstanceArn='string',
    PermissionSetArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set that will be used to remove access.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_instance_access_control_attribute_configuration(**kwargs)

Disables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_instance_access_control_attribute_configuration(
    InstanceArn='string'
)
Parameters
InstanceArn (string) --

[REQUIRED]

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_permission_set(**kwargs)

Deletes the specified permission set.

See also: AWS API Documentation

Request Syntax

response = client.delete_permission_set(
    InstanceArn='string',
    PermissionSetArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set that should be deleted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_permissions_boundary_from_permission_set(**kwargs)

Deletes the permissions boundary from a specified PermissionSet .

See also: AWS API Documentation

Request Syntax

response = client.delete_permissions_boundary_from_permission_set(
    InstanceArn='string',
    PermissionSetArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

describe_account_assignment_creation_status(**kwargs)

Describes the status of the assignment creation request.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_assignment_creation_status(
    InstanceArn='string',
    AccountAssignmentCreationRequestId='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • AccountAssignmentCreationRequestId (string) --

    [REQUIRED]

    The identifier that is used to track the request operation progress.

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentCreationStatus': {
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'RequestId': 'string',
        'FailureReason': 'string',
        'TargetId': 'string',
        'TargetType': 'AWS_ACCOUNT',
        'PermissionSetArn': 'string',
        'PrincipalType': 'USER'|'GROUP',
        'PrincipalId': 'string',
        'CreatedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • AccountAssignmentCreationStatus (dict) --

      The status object for the account assignment creation operation.

      • Status (string) --

        The status of the permission set provisioning process.

      • RequestId (string) --

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • FailureReason (string) --

        The message that contains an error or exception in case of an operation failure.

      • TargetId (string) --

        TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

      • TargetType (string) --

        The entity type for which the assignment will be created.

      • PermissionSetArn (string) --

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • PrincipalType (string) --

        The entity type for which the assignment will be created.

      • PrincipalId (string) --

        An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

      • CreatedDate (datetime) --

        The date that the permission set was created.

Exceptions

describe_account_assignment_deletion_status(**kwargs)

Describes the status of the assignment deletion request.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_assignment_deletion_status(
    InstanceArn='string',
    AccountAssignmentDeletionRequestId='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • AccountAssignmentDeletionRequestId (string) --

    [REQUIRED]

    The identifier that is used to track the request operation progress.

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentDeletionStatus': {
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'RequestId': 'string',
        'FailureReason': 'string',
        'TargetId': 'string',
        'TargetType': 'AWS_ACCOUNT',
        'PermissionSetArn': 'string',
        'PrincipalType': 'USER'|'GROUP',
        'PrincipalId': 'string',
        'CreatedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • AccountAssignmentDeletionStatus (dict) --

      The status object for the account assignment deletion operation.

      • Status (string) --

        The status of the permission set provisioning process.

      • RequestId (string) --

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • FailureReason (string) --

        The message that contains an error or exception in case of an operation failure.

      • TargetId (string) --

        TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).

      • TargetType (string) --

        The entity type for which the assignment will be created.

      • PermissionSetArn (string) --

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • PrincipalType (string) --

        The entity type for which the assignment will be created.

      • PrincipalId (string) --

        An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

      • CreatedDate (datetime) --

        The date that the permission set was created.

Exceptions

describe_instance_access_control_attribute_configuration(**kwargs)

Returns the list of Amazon Web Services SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified Amazon Web Services SSO instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_instance_access_control_attribute_configuration(
    InstanceArn='string'
)
Parameters
InstanceArn (string) --

[REQUIRED]

The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

Return type
dict
Returns
Response Syntax
{
    'Status': 'ENABLED'|'CREATION_IN_PROGRESS'|'CREATION_FAILED',
    'StatusReason': 'string',
    'InstanceAccessControlAttributeConfiguration': {
        'AccessControlAttributes': [
            {
                'Key': 'string',
                'Value': {
                    'Source': [
                        'string',
                    ]
                }
            },
        ]
    }
}

Response Structure

  • (dict) --
    • Status (string) --

      The status of the attribute configuration process.

    • StatusReason (string) --

      Provides more details about the current status of the specified attribute.

    • InstanceAccessControlAttributeConfiguration (dict) --

      Gets the list of Amazon Web Services SSO identity store attributes that have been added to your ABAC configuration.

      • AccessControlAttributes (list) --

        Lists the attributes that are configured for ABAC in the specified Amazon Web Services SSO instance.

        • (dict) --

          These are Amazon Web Services SSO identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your Amazon Web Services resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes , Amazon Web Services SSO passes the attribute values of the authenticated user into IAM for use in policy evaluation.

          • Key (string) --

            The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in Amazon Web Services SSO.

          • Value (dict) --

            The value used for mapping a specified attribute to an identity source.

            • Source (list) --

              The identity source to use when mapping a specified attribute to Amazon Web Services SSO.

              • (string) --

Exceptions

describe_permission_set(**kwargs)

Gets the details of the permission set.

See also: AWS API Documentation

Request Syntax

response = client.describe_permission_set(
    InstanceArn='string',
    PermissionSetArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set.

Return type

dict

Returns

Response Syntax

{
    'PermissionSet': {
        'Name': 'string',
        'PermissionSetArn': 'string',
        'Description': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'SessionDuration': 'string',
        'RelayState': 'string'
    }
}

Response Structure

  • (dict) --

    • PermissionSet (dict) --

      Describes the level of access on an Amazon Web Services account.

      • Name (string) --

        The name of the permission set.

      • PermissionSetArn (string) --

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • Description (string) --

        The description of the PermissionSet .

      • CreatedDate (datetime) --

        The date that the permission set was created.

      • SessionDuration (string) --

        The length of time that the application user sessions are valid for in the ISO-8601 standard.

      • RelayState (string) --

        Used to redirect users within the application during the federation authentication process.

Exceptions

describe_permission_set_provisioning_status(**kwargs)

Describes the status for the given permission set provisioning request.

See also: AWS API Documentation

Request Syntax

response = client.describe_permission_set_provisioning_status(
    InstanceArn='string',
    ProvisionPermissionSetRequestId='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • ProvisionPermissionSetRequestId (string) --

    [REQUIRED]

    The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.

Return type

dict

Returns

Response Syntax

{
    'PermissionSetProvisioningStatus': {
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'RequestId': 'string',
        'AccountId': 'string',
        'PermissionSetArn': 'string',
        'FailureReason': 'string',
        'CreatedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • PermissionSetProvisioningStatus (dict) --

      The status object for the permission set provisioning operation.

      • Status (string) --

        The status of the permission set provisioning process.

      • RequestId (string) --

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • AccountId (string) --

        The identifier of the Amazon Web Services account from which to list the assignments.

      • PermissionSetArn (string) --

        The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • FailureReason (string) --

        The message that contains an error or exception in case of an operation failure.

      • CreatedDate (datetime) --

        The date that the permission set was created.

Exceptions

detach_customer_managed_policy_reference_from_permission_set(**kwargs)

Detaches the specified customer managed policy from the specified PermissionSet .

See also: AWS API Documentation

Request Syntax

response = client.detach_customer_managed_policy_reference_from_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    CustomerManagedPolicyReference={
        'Name': 'string',
        'Path': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet .

  • CustomerManagedPolicyReference (dict) --

    [REQUIRED]

    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

    • Name (string) -- [REQUIRED]

      The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

    • Path (string) --

      The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the Identity and Access Management User Guide .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

detach_managed_policy_from_permission_set(**kwargs)

Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.

See also: AWS API Documentation

Request Syntax

response = client.detach_managed_policy_from_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    ManagedPolicyArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet from which the policy should be detached.

  • ManagedPolicyArn (string) --

    [REQUIRED]

    The Amazon Web Services managed policy ARN to be detached from a permission set.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

get_inline_policy_for_permission_set(**kwargs)

Obtains the inline policy assigned to the permission set.

See also: AWS API Documentation

Request Syntax

response = client.get_inline_policy_for_permission_set(
    InstanceArn='string',
    PermissionSetArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set.

Return type

dict

Returns

Response Syntax

{
    'InlinePolicy': 'string'
}

Response Structure

  • (dict) --

    • InlinePolicy (string) --

      The inline policy that is attached to the permission set.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_permissions_boundary_for_permission_set(**kwargs)

Obtains the permissions boundary for a specified PermissionSet .

See also: AWS API Documentation

Request Syntax

response = client.get_permissions_boundary_for_permission_set(
    InstanceArn='string',
    PermissionSetArn='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet .

Return type

dict

Returns

Response Syntax

{
    'PermissionsBoundary': {
        'CustomerManagedPolicyReference': {
            'Name': 'string',
            'Path': 'string'
        },
        'ManagedPolicyArn': 'string'
    }
}

Response Structure

  • (dict) --

    • PermissionsBoundary (dict) --

      The permissions boundary attached to the specified permission set.

      • CustomerManagedPolicyReference (dict) --

        Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

        • Name (string) --

          The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

        • Path (string) --

          The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the Identity and Access Management User Guide .

      • ManagedPolicyArn (string) --

        The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_account_assignment_creation_status(**kwargs)

Lists the status of the Amazon Web Services account assignment creation requests for a specified Amazon Web Services SSO instance.

See also: AWS API Documentation

Request Syntax

response = client.list_account_assignment_creation_status(
    InstanceArn='string',
    MaxResults=123,
    NextToken='string',
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • MaxResults (integer) -- The maximum number of results to display for the assignment.
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
  • Filter (dict) --

    Filters results based on the passed attribute value.

    • Status (string) --

      Filters the list operations result based on the status attribute.

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentsCreationStatus': [
        {
            'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
            'RequestId': 'string',
            'CreatedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccountAssignmentsCreationStatus (list) --

      The status object for the account assignment creation operation.

      • (dict) --

        Provides information about the AccountAssignment creation request.

        • Status (string) --

          The status of the permission set provisioning process.

        • RequestId (string) --

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate (datetime) --

          The date that the permission set was created.

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_account_assignment_deletion_status(**kwargs)

Lists the status of the Amazon Web Services account assignment deletion requests for a specified Amazon Web Services SSO instance.

See also: AWS API Documentation

Request Syntax

response = client.list_account_assignment_deletion_status(
    InstanceArn='string',
    MaxResults=123,
    NextToken='string',
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • MaxResults (integer) -- The maximum number of results to display for the assignment.
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
  • Filter (dict) --

    Filters results based on the passed attribute value.

    • Status (string) --

      Filters the list operations result based on the status attribute.

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentsDeletionStatus': [
        {
            'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
            'RequestId': 'string',
            'CreatedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccountAssignmentsDeletionStatus (list) --

      The status object for the account assignment deletion operation.

      • (dict) --

        Provides information about the AccountAssignment creation request.

        • Status (string) --

          The status of the permission set provisioning process.

        • RequestId (string) --

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate (datetime) --

          The date that the permission set was created.

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_account_assignments(**kwargs)

Lists the assignee of the specified Amazon Web Services account with the specified permission set.

See also: AWS API Documentation

Request Syntax

response = client.list_account_assignments(
    InstanceArn='string',
    AccountId='string',
    PermissionSetArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • AccountId (string) --

    [REQUIRED]

    The identifier of the Amazon Web Services account from which to list the assignments.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set from which to list assignments.

  • MaxResults (integer) -- The maximum number of results to display for the assignment.
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Return type

dict

Returns

Response Syntax

{
    'AccountAssignments': [
        {
            'AccountId': 'string',
            'PermissionSetArn': 'string',
            'PrincipalType': 'USER'|'GROUP',
            'PrincipalId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccountAssignments (list) --

      The list of assignments that match the input Amazon Web Services account and permission set.

      • (dict) --

        The assignment that indicates a principal's limited access to a specified Amazon Web Services account with a specified permission set.

        Note

        The term principal here refers to a user or group that is defined in Amazon Web Services SSO.

        • AccountId (string) --

          The identifier of the Amazon Web Services account.

        • PermissionSetArn (string) --

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

        • PrincipalType (string) --

          The entity type for which the assignment will be created.

        • PrincipalId (string) --

          An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_accounts_for_provisioned_permission_set(**kwargs)

Lists all the Amazon Web Services accounts where the specified permission set is provisioned.

See also: AWS API Documentation

Request Syntax

response = client.list_accounts_for_provisioned_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.

  • ProvisioningStatus (string) -- The permission set provisioning status for an Amazon Web Services account.
  • MaxResults (integer) -- The maximum number of results to display for the PermissionSet .
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Return type

dict

Returns

Response Syntax

{
    'AccountIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccountIds (list) --

      The list of Amazon Web Services AccountIds .

      • (string) --
    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_customer_managed_policy_references_in_permission_set(**kwargs)

Lists all customer managed policies attached to a specified PermissionSet .

See also: AWS API Documentation

Request Syntax

response = client.list_customer_managed_policy_references_in_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet .

  • MaxResults (integer) -- The maximum number of results to display for the list call.
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Return type

dict

Returns

Response Syntax

{
    'CustomerManagedPolicyReferences': [
        {
            'Name': 'string',
            'Path': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CustomerManagedPolicyReferences (list) --

      Specifies the names and paths of the customer managed policies that you have attached to your permission set.

      • (dict) --

        Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

        • Name (string) --

          The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

        • Path (string) --

          The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the Identity and Access Management User Guide .

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_instances(**kwargs)

Lists the Amazon Web Services SSO instances that the caller has access to.

See also: AWS API Documentation

Request Syntax

response = client.list_instances(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to display for the instance.
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Return type

dict

Returns

Response Syntax

{
    'Instances': [
        {
            'InstanceArn': 'string',
            'IdentityStoreId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Instances (list) --

      Lists the Amazon Web Services SSO instances that the caller has access to.

      • (dict) --

        Provides information about the Amazon Web Services SSO instance.

        • InstanceArn (string) --

          The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

        • IdentityStoreId (string) --

          The identifier of the identity store that is connected to the Amazon Web Services SSO instance.

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_managed_policies_in_permission_set(**kwargs)

Lists the Amazon Web Services managed policy that is attached to a specified permission set.

See also: AWS API Documentation

Request Syntax

response = client.list_managed_policies_in_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet whose managed policies will be listed.

  • MaxResults (integer) -- The maximum number of results to display for the PermissionSet .
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Return type

dict

Returns

Response Syntax

{
    'AttachedManagedPolicies': [
        {
            'Name': 'string',
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AttachedManagedPolicies (list) --

      An array of the AttachedManagedPolicy data type object.

      • (dict) --

        A structure that stores the details of the Amazon Web Services managed policy.

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_permission_set_provisioning_status(**kwargs)

Lists the status of the permission set provisioning requests for a specified Amazon Web Services SSO instance.

See also: AWS API Documentation

Request Syntax

response = client.list_permission_set_provisioning_status(
    InstanceArn='string',
    MaxResults=123,
    NextToken='string',
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • MaxResults (integer) -- The maximum number of results to display for the assignment.
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
  • Filter (dict) --

    Filters results based on the passed attribute value.

    • Status (string) --

      Filters the list operations result based on the status attribute.

Return type

dict

Returns

Response Syntax

{
    'PermissionSetsProvisioningStatus': [
        {
            'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
            'RequestId': 'string',
            'CreatedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PermissionSetsProvisioningStatus (list) --

      The status object for the permission set provisioning operation.

      • (dict) --

        Provides information about the permission set provisioning status.

        • Status (string) --

          The status of the permission set provisioning process.

        • RequestId (string) --

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate (datetime) --

          The date that the permission set was created.

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_permission_sets(**kwargs)

Lists the PermissionSet s in an Amazon Web Services SSO instance.

See also: AWS API Documentation

Request Syntax

response = client.list_permission_sets(
    InstanceArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
  • MaxResults (integer) -- The maximum number of results to display for the assignment.
Return type

dict

Returns

Response Syntax

{
    'PermissionSets': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PermissionSets (list) --

      Defines the level of access on an Amazon Web Services account.

      • (string) --
    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

list_permission_sets_provisioned_to_account(**kwargs)

Lists all the permission sets that are provisioned to a specified Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_permission_sets_provisioned_to_account(
    InstanceArn='string',
    AccountId='string',
    ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • AccountId (string) --

    [REQUIRED]

    The identifier of the Amazon Web Services account from which to list the assignments.

  • ProvisioningStatus (string) -- The status object for the permission set provisioning operation.
  • MaxResults (integer) -- The maximum number of results to display for the assignment.
  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'PermissionSets': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

    • PermissionSets (list) --

      Defines the level of access that an Amazon Web Services account has.

      • (string) --

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags that are attached to a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    InstanceArn='string',
    ResourceArn='string',
    NextToken='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource with the tags to be listed.

  • NextToken (string) -- The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Tags (list) --

      A set of key-value pairs that are used to manage the resource.

      • (dict) --

        A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that Amazon Web Services SSO creates in Amazon Web Services accounts.

        • Key (string) --

          The key for the tag.

        • Value (string) --

          The value of the tag.

    • NextToken (string) --

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Exceptions

provision_permission_set(**kwargs)

The process by which a specified permission set is provisioned to the specified target.

See also: AWS API Documentation

Request Syntax

response = client.provision_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    TargetId='string',
    TargetType='AWS_ACCOUNT'|'ALL_PROVISIONED_ACCOUNTS'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set.

  • TargetId (string) -- TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
  • TargetType (string) --

    [REQUIRED]

    The entity type for which the assignment will be created.

Return type

dict

Returns

Response Syntax

{
    'PermissionSetProvisioningStatus': {
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
        'RequestId': 'string',
        'AccountId': 'string',
        'PermissionSetArn': 'string',
        'FailureReason': 'string',
        'CreatedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • PermissionSetProvisioningStatus (dict) --

      The status object for the permission set provisioning operation.

      • Status (string) --

        The status of the permission set provisioning process.

      • RequestId (string) --

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • AccountId (string) --

        The identifier of the Amazon Web Services account from which to list the assignments.

      • PermissionSetArn (string) --

        The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

      • FailureReason (string) --

        The message that contains an error or exception in case of an operation failure.

      • CreatedDate (datetime) --

        The date that the permission set was created.

Exceptions

put_inline_policy_to_permission_set(**kwargs)

Attaches an inline policy to a permission set.

Note

If the permission set is already referenced by one or more account assignments, you will need to call `` ProvisionPermissionSet `` after this action to apply the corresponding IAM policy updates to all assigned accounts.

See also: AWS API Documentation

Request Syntax

response = client.put_inline_policy_to_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    InlinePolicy='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set.

  • InlinePolicy (string) --

    [REQUIRED]

    The inline policy to attach to a PermissionSet .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

put_permissions_boundary_to_permission_set(**kwargs)

Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.

See also: AWS API Documentation

Request Syntax

response = client.put_permissions_boundary_to_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    PermissionsBoundary={
        'CustomerManagedPolicyReference': {
            'Name': 'string',
            'Path': 'string'
        },
        'ManagedPolicyArn': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet .

  • PermissionsBoundary (dict) --

    [REQUIRED]

    The permissions boundary that you want to attach to a PermissionSet .

    • CustomerManagedPolicyReference (dict) --

      Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

      • Name (string) -- [REQUIRED]

        The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

      • Path (string) --

        The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the Identity and Access Management User Guide .

    • ManagedPolicyArn (string) --

      The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

Associates a set of tags with a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    InstanceArn='string',
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource with the tags to be listed.

  • Tags (list) --

    [REQUIRED]

    A set of key-value pairs that are used to manage the resource.

    • (dict) --

      A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that Amazon Web Services SSO creates in Amazon Web Services accounts.

      • Key (string) -- [REQUIRED]

        The key for the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Disassociates a set of tags from a specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    InstanceArn='string',
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource with the tags to be listed.

  • TagKeys (list) --

    [REQUIRED]

    The keys of tags that are attached to the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_instance_access_control_attribute_configuration(**kwargs)

Updates the Amazon Web Services SSO identity store attributes that you can use with the Amazon Web Services SSO instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the Amazon Web Services SSO identity store. If a SAML assertion passes any of these attributes, Amazon Web Services SSO replaces the attribute value with the value from the Amazon Web Services SSO identity store. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide .

See also: AWS API Documentation

Request Syntax

response = client.update_instance_access_control_attribute_configuration(
    InstanceArn='string',
    InstanceAccessControlAttributeConfiguration={
        'AccessControlAttributes': [
            {
                'Key': 'string',
                'Value': {
                    'Source': [
                        'string',
                    ]
                }
            },
        ]
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • InstanceAccessControlAttributeConfiguration (dict) --

    [REQUIRED]

    Updates the attributes for your ABAC configuration.

    • AccessControlAttributes (list) -- [REQUIRED]

      Lists the attributes that are configured for ABAC in the specified Amazon Web Services SSO instance.

      • (dict) --

        These are Amazon Web Services SSO identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your Amazon Web Services resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes , Amazon Web Services SSO passes the attribute values of the authenticated user into IAM for use in policy evaluation.

        • Key (string) -- [REQUIRED]

          The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in Amazon Web Services SSO.

        • Value (dict) -- [REQUIRED]

          The value used for mapping a specified attribute to an identity source.

          • Source (list) -- [REQUIRED]

            The identity source to use when mapping a specified attribute to Amazon Web Services SSO.

            • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_permission_set(**kwargs)

Updates an existing permission set.

See also: AWS API Documentation

Request Syntax

response = client.update_permission_set(
    InstanceArn='string',
    PermissionSetArn='string',
    Description='string',
    SessionDuration='string',
    RelayState='string'
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set.

  • Description (string) -- The description of the PermissionSet .
  • SessionDuration (string) -- The length of time that the application user sessions are valid for in the ISO-8601 standard.
  • RelayState (string) -- Used to redirect users within the application during the federation authentication process.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class SSOAdmin.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSOAdmin.Client.exceptions.ConflictException

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSOAdmin.Client.exceptions.InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception, or failure with an internal server.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSOAdmin.Client.exceptions.ResourceNotFoundException

Indicates that a requested resource is not found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Indicates that a requested resource is not found.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSOAdmin.Client.exceptions.ServiceQuotaExceededException

Indicates that the principal has crossed the permitted number of resources that can be created.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Indicates that the principal has crossed the permitted number of resources that can be created.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSOAdmin.Client.exceptions.ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Indicates that the principal has crossed the throttling limits of the API operations.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSOAdmin.Client.exceptions.ValidationException

The request failed because it contains a syntax error.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request failed because it contains a syntax error.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class SSOAdmin.Paginator.ListAccountAssignmentCreationStatus
paginator = client.get_paginator('list_account_assignment_creation_status')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_account_assignment_creation_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • Filter (dict) --

    Filters results based on the passed attribute value.

    • Status (string) --

      Filters the list operations result based on the status attribute.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentsCreationStatus': [
        {
            'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
            'RequestId': 'string',
            'CreatedDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • AccountAssignmentsCreationStatus (list) --

      The status object for the account assignment creation operation.

      • (dict) --

        Provides information about the AccountAssignment creation request.

        • Status (string) --

          The status of the permission set provisioning process.

        • RequestId (string) --

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate (datetime) --

          The date that the permission set was created.

class SSOAdmin.Paginator.ListAccountAssignmentDeletionStatus
paginator = client.get_paginator('list_account_assignment_deletion_status')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_account_assignment_deletion_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • Filter (dict) --

    Filters results based on the passed attribute value.

    • Status (string) --

      Filters the list operations result based on the status attribute.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AccountAssignmentsDeletionStatus': [
        {
            'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
            'RequestId': 'string',
            'CreatedDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • AccountAssignmentsDeletionStatus (list) --

      The status object for the account assignment deletion operation.

      • (dict) --

        Provides information about the AccountAssignment creation request.

        • Status (string) --

          The status of the permission set provisioning process.

        • RequestId (string) --

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate (datetime) --

          The date that the permission set was created.

class SSOAdmin.Paginator.ListAccountAssignments
paginator = client.get_paginator('list_account_assignments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_account_assignments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    AccountId='string',
    PermissionSetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • AccountId (string) --

    [REQUIRED]

    The identifier of the Amazon Web Services account from which to list the assignments.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the permission set from which to list assignments.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AccountAssignments': [
        {
            'AccountId': 'string',
            'PermissionSetArn': 'string',
            'PrincipalType': 'USER'|'GROUP',
            'PrincipalId': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • AccountAssignments (list) --

      The list of assignments that match the input Amazon Web Services account and permission set.

      • (dict) --

        The assignment that indicates a principal's limited access to a specified Amazon Web Services account with a specified permission set.

        Note

        The term principal here refers to a user or group that is defined in Amazon Web Services SSO.

        • AccountId (string) --

          The identifier of the Amazon Web Services account.

        • PermissionSetArn (string) --

          The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

        • PrincipalType (string) --

          The entity type for which the assignment will be created.

        • PrincipalId (string) --

          An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference .

class SSOAdmin.Paginator.ListAccountsForProvisionedPermissionSet
paginator = client.get_paginator('list_accounts_for_provisioned_permission_set')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_accounts_for_provisioned_permission_set().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    PermissionSetArn='string',
    ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.

  • ProvisioningStatus (string) -- The permission set provisioning status for an Amazon Web Services account.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AccountIds': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • AccountIds (list) --

      The list of Amazon Web Services AccountIds .

      • (string) --

class SSOAdmin.Paginator.ListCustomerManagedPolicyReferencesInPermissionSet
paginator = client.get_paginator('list_customer_managed_policy_references_in_permission_set')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_customer_managed_policy_references_in_permission_set().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    PermissionSetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed.

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet .

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'CustomerManagedPolicyReferences': [
        {
            'Name': 'string',
            'Path': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • CustomerManagedPolicyReferences (list) --

      Specifies the names and paths of the customer managed policies that you have attached to your permission set.

      • (dict) --

        Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

        • Name (string) --

          The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

        • Path (string) --

          The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is / . For more information, see Friendly names and paths in the Identity and Access Management User Guide .

class SSOAdmin.Paginator.ListInstances
paginator = client.get_paginator('list_instances')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Instances': [
        {
            'InstanceArn': 'string',
            'IdentityStoreId': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • Instances (list) --

      Lists the Amazon Web Services SSO instances that the caller has access to.

      • (dict) --

        Provides information about the Amazon Web Services SSO instance.

        • InstanceArn (string) --

          The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

        • IdentityStoreId (string) --

          The identifier of the identity store that is connected to the Amazon Web Services SSO instance.

class SSOAdmin.Paginator.ListManagedPoliciesInPermissionSet
paginator = client.get_paginator('list_managed_policies_in_permission_set')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_managed_policies_in_permission_set().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    PermissionSetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PermissionSetArn (string) --

    [REQUIRED]

    The ARN of the PermissionSet whose managed policies will be listed.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AttachedManagedPolicies': [
        {
            'Name': 'string',
            'Arn': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • AttachedManagedPolicies (list) --

      An array of the AttachedManagedPolicy data type object.

      • (dict) --

        A structure that stores the details of the Amazon Web Services managed policy.

class SSOAdmin.Paginator.ListPermissionSetProvisioningStatus
paginator = client.get_paginator('list_permission_set_provisioning_status')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_permission_set_provisioning_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    Filter={
        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • Filter (dict) --

    Filters results based on the passed attribute value.

    • Status (string) --

      Filters the list operations result based on the status attribute.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'PermissionSetsProvisioningStatus': [
        {
            'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
            'RequestId': 'string',
            'CreatedDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • PermissionSetsProvisioningStatus (list) --

      The status object for the permission set provisioning operation.

      • (dict) --

        Provides information about the permission set provisioning status.

        • Status (string) --

          The status of the permission set provisioning process.

        • RequestId (string) --

          The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

        • CreatedDate (datetime) --

          The date that the permission set was created.

class SSOAdmin.Paginator.ListPermissionSets
paginator = client.get_paginator('list_permission_sets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_permission_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'PermissionSets': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • PermissionSets (list) --

      Defines the level of access on an Amazon Web Services account.

      • (string) --

class SSOAdmin.Paginator.ListPermissionSetsProvisionedToAccount
paginator = client.get_paginator('list_permission_sets_provisioned_to_account')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_permission_sets_provisioned_to_account().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    AccountId='string',
    ProvisioningStatus='LATEST_PERMISSION_SET_PROVISIONED'|'LATEST_PERMISSION_SET_NOT_PROVISIONED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • AccountId (string) --

    [REQUIRED]

    The identifier of the Amazon Web Services account from which to list the assignments.

  • ProvisioningStatus (string) -- The status object for the permission set provisioning operation.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'PermissionSets': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • PermissionSets (list) --

      Defines the level of access that an Amazon Web Services account has.

      • (string) --

class SSOAdmin.Paginator.ListTagsForResource
paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InstanceArn (string) --

    [REQUIRED]

    The ARN of the Amazon Web Services SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .

  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource with the tags to be listed.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • Tags (list) --

      A set of key-value pairs that are used to manage the resource.

      • (dict) --

        A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that Amazon Web Services SSO creates in Amazon Web Services accounts.

        • Key (string) --

          The key for the tag.

        • Value (string) --

          The value of the tag.