AWS.SSOAdmin (aws-elixir v0.8.0) View Source

Link to this section Summary

Functions

Attaches an IAM managed policy ARN to a permission set.

Assigns access to a principal for a specified AWS account using a specified permission set.

Enables the attributes-based access control (ABAC) feature for the specified AWS SSO instance.

Creates a permission set within a specified SSO instance.

Deletes a principal's access from a specified AWS account using a specified permission set.

Deletes the inline policy from a specified permission set.

Disables the attributes-based access control (ABAC) feature for the specified AWS SSO instance and deletes all of the attribute mappings that have been configured.

Deletes the specified permission set.

Describes the status of the assignment creation request.

Describes the status of the assignment deletion request.

Returns the list of AWS SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified AWS SSO instance.

Gets the details of the permission set.

Describes the status for the given permission set provisioning request.

Detaches the attached IAM managed policy ARN from the specified permission set.

Obtains the inline policy assigned to the permission set.

Lists the status of the AWS account assignment creation requests for a specified SSO instance.

Lists the status of the AWS account assignment deletion requests for a specified SSO instance.

Lists the assignee of the specified AWS account with the specified permission set.

Lists all the AWS accounts where the specified permission set is provisioned.

Lists the SSO instances that the caller has access to.

Lists the IAM managed policy that is attached to a specified permission set.

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

Lists the PermissionSets in an SSO instance.

Lists all the permission sets that are provisioned to a specified AWS account.

Lists the tags that are attached to a specified resource.

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

Attaches an IAM inline policy to a permission set.

Associates a set of tags with a specified resource.

Disassociates a set of tags from a specified resource.

Updates the AWS SSO identity store attributes to use with the AWS SSO instance for attributes-based access control (ABAC).

Updates an existing permission set.

Link to this section Functions

Link to this function

attach_managed_policy_to_permission_set(client, input, options \\ [])

View Source

Attaches an IAM managed policy ARN to a permission set.

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.

Link to this function

create_account_assignment(client, input, options \\ [])

View Source

Assigns access to a principal for a specified AWS account using a specified permission set.

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

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 attached to the SSO-created IAM role. 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 will need to call ProvisionPermissionSet to make these updates.

Link to this function

create_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

Enables the attributes-based access control (ABAC) feature for the specified AWS 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 AWS SSO User Guide.

Link to this function

create_permission_set(client, input, options \\ [])

View Source

Creates a permission set within a specified SSO instance.

To grant users and groups access to AWS account resources, use CreateAccountAssignment.

Link to this function

delete_account_assignment(client, input, options \\ [])

View Source

Deletes a principal's access from a specified AWS account using a specified permission set.

Link to this function

delete_inline_policy_from_permission_set(client, input, options \\ [])

View Source

Deletes the inline policy from a specified permission set.

Link to this function

delete_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

Disables the attributes-based access control (ABAC) feature for the specified AWS 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 AWS SSO User Guide.

Link to this function

delete_permission_set(client, input, options \\ [])

View Source

Deletes the specified permission set.

Link to this function

describe_account_assignment_creation_status(client, input, options \\ [])

View Source

Describes the status of the assignment creation request.

Link to this function

describe_account_assignment_deletion_status(client, input, options \\ [])

View Source

Describes the status of the assignment deletion request.

Link to this function

describe_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

Returns the list of AWS SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified AWS 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 AWS SSO User Guide.

Link to this function

describe_permission_set(client, input, options \\ [])

View Source

Gets the details of the permission set.

Link to this function

describe_permission_set_provisioning_status(client, input, options \\ [])

View Source

Describes the status for the given permission set provisioning request.

Link to this function

detach_managed_policy_from_permission_set(client, input, options \\ [])

View Source

Detaches the attached IAM managed policy ARN from the specified permission set.

Link to this function

get_inline_policy_for_permission_set(client, input, options \\ [])

View Source

Obtains the inline policy assigned to the permission set.

Link to this function

list_account_assignment_creation_status(client, input, options \\ [])

View Source

Lists the status of the AWS account assignment creation requests for a specified SSO instance.

Link to this function

list_account_assignment_deletion_status(client, input, options \\ [])

View Source

Lists the status of the AWS account assignment deletion requests for a specified SSO instance.

Link to this function

list_account_assignments(client, input, options \\ [])

View Source

Lists the assignee of the specified AWS account with the specified permission set.

Link to this function

list_accounts_for_provisioned_permission_set(client, input, options \\ [])

View Source

Lists all the AWS accounts where the specified permission set is provisioned.

Link to this function

list_instances(client, input, options \\ [])

View Source

Lists the SSO instances that the caller has access to.

Link to this function

list_managed_policies_in_permission_set(client, input, options \\ [])

View Source

Lists the IAM managed policy that is attached to a specified permission set.

Link to this function

list_permission_set_provisioning_status(client, input, options \\ [])

View Source

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

Link to this function

list_permission_sets(client, input, options \\ [])

View Source

Lists the PermissionSets in an SSO instance.

Link to this function

list_permission_sets_provisioned_to_account(client, input, options \\ [])

View Source

Lists all the permission sets that are provisioned to a specified AWS account.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags that are attached to a specified resource.

Link to this function

provision_permission_set(client, input, options \\ [])

View Source

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

Link to this function

put_inline_policy_to_permission_set(client, input, options \\ [])

View Source

Attaches an IAM inline policy to a permission set.

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Associates a set of tags with a specified resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Disassociates a set of tags from a specified resource.

Link to this function

update_instance_access_control_attribute_configuration(client, input, options \\ [])

View Source

Updates the AWS SSO identity store attributes to use with the AWS 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 AWS SSO identity store. If a SAML assertion passes any of these attributes, AWS SSO will replace the attribute value with the value from the AWS SSO identity store. For more information about ABAC, see Attribute-Based Access Control in the AWS SSO User Guide.

Link to this function

update_permission_set(client, input, options \\ [])

View Source

Updates an existing permission set.