# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.SSOAdmin do
@moduledoc """
AWS IAM Identity Center (successor to AWS Single Sign-On) helps you securely
create, or connect, your workforce identities and manage their access centrally
across AWS accounts and applications.
IAM Identity Center is the recommended approach for workforce authentication and
authorization in AWS, for organizations of any size and type.
Although AWS Single Sign-On was renamed, the `sso` and `identitystore` API
namespaces will continue to retain their original name for backward
compatibility purposes. For more information, see [IAM Identity Center rename](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed).
This reference guide provides information on single sign-on operations which
could be used for access management of AWS accounts. For information about IAM
Identity Center features, see the [IAM Identity Center User Guide](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html).
Many operations in the IAM Identity Center APIs rely on identifiers for users
and groups, known as principals. For more information about how to work with
principals and principal IDs in IAM Identity Center, see the [Identity Store API Reference](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html).
AWS provides SDKs that consist of libraries and sample code for various
programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more).
The SDKs provide a convenient way to create programmatic access to IAM Identity
Center and other AWS services. For more information about the AWS SDKs,
including how to download and install them, see [Tools for Amazon Web Services](http://aws.amazon.com/tools/).
"""
alias AWS.Client
alias AWS.Request
def metadata do
%{
abbreviation: "SSO Admin",
api_version: "2020-07-20",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "sso",
global?: false,
protocol: "json",
service_id: "SSO Admin",
signature_version: "v4",
signing_name: "sso",
target_prefix: "SWBExternalService"
}
end
@doc """
Attaches the specified customer managed policy to the specified `PermissionSet`.
"""
def attach_customer_managed_policy_reference_to_permission_set(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"AttachCustomerManagedPolicyReferenceToPermissionSet",
input,
options
)
end
@doc """
Attaches an AWS 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 operation. Calling
`ProvisionPermissionSet` applies the corresponding IAM policy updates to all
assigned accounts.
"""
def attach_managed_policy_to_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AttachManagedPolicyToPermissionSet", input, options)
end
@doc """
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 IAM
Identity Center.
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 IAM Identity Center.
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.
After a successful response, call `DescribeAccountAssignmentCreationStatus` to
describe the status of an assignment creation request.
"""
def create_account_assignment(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateAccountAssignment", input, options)
end
@doc """
Enables the attributes-based access control (ABAC) feature for the specified IAM
Identity Center 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](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center
User Guide*.
After a successful response, call
`DescribeInstanceAccessControlAttributeConfiguration` to validate that
`InstanceAccessControlAttributeConfiguration` was created.
"""
def create_instance_access_control_attribute_configuration(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"CreateInstanceAccessControlAttributeConfiguration",
input,
options
)
end
@doc """
Creates a permission set within a specified IAM Identity Center instance.
To grant users and groups access to AWS account resources, use `
`CreateAccountAssignment` `.
"""
def create_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreatePermissionSet", input, options)
end
@doc """
Deletes a principal's access from a specified AWS account using a specified
permission set.
After a successful response, call `DescribeAccountAssignmentCreationStatus` to
describe the status of an assignment deletion request.
"""
def delete_account_assignment(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteAccountAssignment", input, options)
end
@doc """
Deletes the inline policy from a specified permission set.
"""
def delete_inline_policy_from_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteInlinePolicyFromPermissionSet", input, options)
end
@doc """
Disables the attributes-based access control (ABAC) feature for the specified
IAM Identity Center 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](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center
User Guide*.
"""
def delete_instance_access_control_attribute_configuration(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"DeleteInstanceAccessControlAttributeConfiguration",
input,
options
)
end
@doc """
Deletes the specified permission set.
"""
def delete_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeletePermissionSet", input, options)
end
@doc """
Deletes the permissions boundary from a specified `PermissionSet`.
"""
def delete_permissions_boundary_from_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(
client,
meta,
"DeletePermissionsBoundaryFromPermissionSet",
input,
options
)
end
@doc """
Describes the status of the assignment creation request.
"""
def describe_account_assignment_creation_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeAccountAssignmentCreationStatus", input, options)
end
@doc """
Describes the status of the assignment deletion request.
"""
def describe_account_assignment_deletion_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeAccountAssignmentDeletionStatus", input, options)
end
@doc """
Returns the list of IAM Identity Center identity store attributes that have been
configured to work with attributes-based access control (ABAC) for the specified
IAM Identity Center instance.
This will not return attributes configured and sent by an external identity
provider. For more information about ABAC, see [Attribute-Based Access Control](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center
User Guide*.
"""
def describe_instance_access_control_attribute_configuration(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"DescribeInstanceAccessControlAttributeConfiguration",
input,
options
)
end
@doc """
Gets the details of the permission set.
"""
def describe_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribePermissionSet", input, options)
end
@doc """
Describes the status for the given permission set provisioning request.
"""
def describe_permission_set_provisioning_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribePermissionSetProvisioningStatus", input, options)
end
@doc """
Detaches the specified customer managed policy from the specified
`PermissionSet`.
"""
def detach_customer_managed_policy_reference_from_permission_set(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"DetachCustomerManagedPolicyReferenceFromPermissionSet",
input,
options
)
end
@doc """
Detaches the attached AWS managed policy ARN from the specified permission set.
"""
def detach_managed_policy_from_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DetachManagedPolicyFromPermissionSet", input, options)
end
@doc """
Obtains the inline policy assigned to the permission set.
"""
def get_inline_policy_for_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInlinePolicyForPermissionSet", input, options)
end
@doc """
Obtains the permissions boundary for a specified `PermissionSet`.
"""
def get_permissions_boundary_for_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetPermissionsBoundaryForPermissionSet", input, options)
end
@doc """
Lists the status of the AWS account assignment creation requests for a specified
IAM Identity Center instance.
"""
def list_account_assignment_creation_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListAccountAssignmentCreationStatus", input, options)
end
@doc """
Lists the status of the AWS account assignment deletion requests for a specified
IAM Identity Center instance.
"""
def list_account_assignment_deletion_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListAccountAssignmentDeletionStatus", input, options)
end
@doc """
Lists the assignee of the specified AWS account with the specified permission
set.
"""
def list_account_assignments(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListAccountAssignments", input, options)
end
@doc """
Lists all the AWS accounts where the specified permission set is provisioned.
"""
def list_accounts_for_provisioned_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListAccountsForProvisionedPermissionSet", input, options)
end
@doc """
Lists all customer managed policies attached to a specified `PermissionSet`.
"""
def list_customer_managed_policy_references_in_permission_set(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"ListCustomerManagedPolicyReferencesInPermissionSet",
input,
options
)
end
@doc """
Lists the IAM Identity Center instances that the caller has access to.
"""
def list_instances(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListInstances", input, options)
end
@doc """
Lists the AWS managed policy that is attached to a specified permission set.
"""
def list_managed_policies_in_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListManagedPoliciesInPermissionSet", input, options)
end
@doc """
Lists the status of the permission set provisioning requests for a specified IAM
Identity Center instance.
"""
def list_permission_set_provisioning_status(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListPermissionSetProvisioningStatus", input, options)
end
@doc """
Lists the `PermissionSet`s in an IAM Identity Center instance.
"""
def list_permission_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListPermissionSets", input, options)
end
@doc """
Lists all the permission sets that are provisioned to a specified AWS account.
"""
def list_permission_sets_provisioned_to_account(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListPermissionSetsProvisionedToAccount", input, options)
end
@doc """
Lists the tags that are attached to a specified resource.
"""
def list_tags_for_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListTagsForResource", input, options)
end
@doc """
The process by which a specified permission set is provisioned to the specified
target.
"""
def provision_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ProvisionPermissionSet", input, options)
end
@doc """
Attaches an 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.
"""
def put_inline_policy_to_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutInlinePolicyToPermissionSet", input, options)
end
@doc """
Attaches an AWS managed or customer managed policy to the specified
`PermissionSet` as a permissions boundary.
"""
def put_permissions_boundary_to_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutPermissionsBoundaryToPermissionSet", input, options)
end
@doc """
Associates a set of tags with a specified resource.
"""
def tag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "TagResource", input, options)
end
@doc """
Disassociates a set of tags from a specified resource.
"""
def untag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UntagResource", input, options)
end
@doc """
Updates the IAM Identity Center identity store attributes that you can use with
the IAM Identity Center 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 IAM Identity Center identity store. If a SAML assertion
passes any of these attributes, IAM Identity Center replaces the attribute value
with the value from the IAM Identity Center identity store. For more information
about ABAC, see [Attribute-Based Access Control](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center
User Guide*.
"""
def update_instance_access_control_attribute_configuration(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"UpdateInstanceAccessControlAttributeConfiguration",
input,
options
)
end
@doc """
Updates an existing permission set.
"""
def update_permission_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdatePermissionSet", input, options)
end
end
