Sso Admin

This page documents function available when using the Sso_Admin module, created with @service Sso_Admin.

Index

Documentation

Main.Sso_Admin.attach_customer_managed_policy_reference_to_permission_setMethod
attach_customer_managed_policy_reference_to_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn)
attach_customer_managed_policy_reference_to_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn, params::Dict{String,<:Any})

Attaches the specified customer managed policy to the specified PermissionSet.

Arguments

  • customer_managed_policy_reference: 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.
  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
  • permission_set_arn: The ARN of the PermissionSet.
source
Main.Sso_Admin.attach_managed_policy_to_permission_setMethod
attach_managed_policy_to_permission_set(instance_arn, managed_policy_arn, permission_set_arn)
attach_managed_policy_to_permission_set(instance_arn, managed_policy_arn, permission_set_arn, params::Dict{String,<:Any})

Attaches an Amazon Web Services 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.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • managed_policy_arn: The Amazon Web Services managed policy ARN to be attached to a permission set.
  • permission_set_arn: The ARN of the PermissionSet that the managed policy should be attached to.
source
Main.Sso_Admin.create_account_assignmentMethod
create_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type)
create_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type, params::Dict{String,<:Any})

Assigns access to a principal for a specified Amazon Web Services 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.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set that the admin wants to grant the principal access to.
  • principal_id: An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
  • principal_type: The entity type for which the assignment will be created.
  • target_id: TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
  • target_type: The entity type for which the assignment will be created.
source
Main.Sso_Admin.create_applicationMethod
create_application(application_provider_arn, instance_arn, name)
create_application(application_provider_arn, instance_arn, name, params::Dict{String,<:Any})

Creates an application in IAM Identity Center for the given application provider.

Arguments

  • application_provider_arn: The ARN of the application provider under which the operation will run.
  • instance_arn: The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
  • name: The name of the .

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
  • "Description": The description of the .
  • "PortalOptions": A structure that describes the options for the portal associated with an application.
  • "Status": Specifies whether the application is enabled or disabled.
  • "Tags": Specifies tags to be attached to the application.
source
Main.Sso_Admin.create_application_assignmentMethod
create_application_assignment(application_arn, principal_id, principal_type)
create_application_assignment(application_arn, principal_id, principal_type, params::Dict{String,<:Any})

Grant application access to a user or group.

Arguments

  • application_arn: The ARN of the application provider under which the operation will run.
  • principal_id: An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
  • principal_type: The entity type for which the assignment will be created.
source
Main.Sso_Admin.create_instanceMethod
create_instance()
create_instance(params::Dict{String,<:Any})

Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions. The CreateInstance request is rejected if the following apply: The instance is created within the organization management account. An instance already exists in the same account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
  • "Name": The name of the instance of IAM Identity Center.
  • "Tags": Specifies tags to be attached to the instance of IAM Identity Center.
source
Main.Sso_Admin.create_instance_access_control_attribute_configurationMethod
create_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn)
create_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn, params::Dict{String,<:Any})

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 in the IAM Identity Center User Guide. After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created.

Arguments

  • instance_access_control_attribute_configuration: Specifies the IAM Identity Center 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 IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.
  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
source
Main.Sso_Admin.create_permission_setMethod
create_permission_set(instance_arn, name)
create_permission_set(instance_arn, name, params::Dict{String,<:Any})

Creates a permission set within a specified IAM Identity Center instance. To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment .

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • name: The name of the PermissionSet.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the PermissionSet.
  • "RelayState": Used to redirect users within the application during the federation authentication process.
  • "SessionDuration": The length of time that the application user sessions are valid in the ISO-8601 standard.
  • "Tags": The tags to attach to the new PermissionSet.
source
Main.Sso_Admin.create_trusted_token_issuerMethod
create_trusted_token_issuer(instance_arn, name, trusted_token_issuer_configuration, trusted_token_issuer_type)
create_trusted_token_issuer(instance_arn, name, trusted_token_issuer_configuration, trusted_token_issuer_type, params::Dict{String,<:Any})

Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services. This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.

Arguments

  • instance_arn: Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.
  • name: Specifies the name of the new trusted token issuer configuration.
  • trusted_token_issuer_configuration: Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what TrustedTokenIssuerType you specify.
  • trusted_token_issuer_type: Specifies the type of the new trusted token issuer.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
  • "Tags": Specifies tags to be attached to the new trusted token issuer configuration.
source
Main.Sso_Admin.delete_account_assignmentMethod
delete_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type)
delete_account_assignment(instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type, params::Dict{String,<:Any})

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set. After a successful response, call DescribeAccountAssignmentDeletionStatus to describe the status of an assignment deletion request.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set that will be used to remove access.
  • principal_id: An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
  • principal_type: The entity type for which the assignment will be deleted.
  • target_id: TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
  • target_type: The entity type for which the assignment will be deleted.
source
Main.Sso_Admin.delete_applicationMethod
delete_application(application_arn)
delete_application(application_arn, params::Dict{String,<:Any})

Deletes the association with the application. The connected service resource still exists.

Arguments

  • application_arn: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
source
Main.Sso_Admin.delete_application_access_scopeMethod
delete_application_access_scope(application_arn, scope)
delete_application_access_scope(application_arn, scope, params::Dict{String,<:Any})

Deletes an IAM Identity Center access scope from an application.

Arguments

  • application_arn: Specifies the ARN of the application with the access scope to delete.
  • scope: Specifies the name of the access scope to remove from the application.
source
Main.Sso_Admin.delete_application_assignmentMethod
delete_application_assignment(application_arn, principal_id, principal_type)
delete_application_assignment(application_arn, principal_id, principal_type, params::Dict{String,<:Any})

Revoke application access to an application by deleting application assignments for a user or group.

Arguments

  • application_arn: Specifies the ARN of the application.
  • principal_id: An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
  • principal_type: The entity type for which the assignment will be deleted.
source
Main.Sso_Admin.delete_application_authentication_methodMethod
delete_application_authentication_method(application_arn, authentication_method_type)
delete_application_authentication_method(application_arn, authentication_method_type, params::Dict{String,<:Any})

Deletes an authentication method from an application.

Arguments

  • application_arn: Specifies the ARN of the application with the authentication method to delete.
  • authentication_method_type: Specifies the authentication method type to delete from the application.
source
Main.Sso_Admin.delete_application_grantMethod
delete_application_grant(application_arn, grant_type)
delete_application_grant(application_arn, grant_type, params::Dict{String,<:Any})

Deletes a grant from an application.

Arguments

  • application_arn: Specifies the ARN of the application with the grant to delete.
  • grant_type: Specifies the type of grant to delete from the application.
source
Main.Sso_Admin.delete_inline_policy_from_permission_setMethod
delete_inline_policy_from_permission_set(instance_arn, permission_set_arn)
delete_inline_policy_from_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Deletes the inline policy from a specified permission set.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set that will be used to remove access.
source
Main.Sso_Admin.delete_instanceMethod
delete_instance(instance_arn)
delete_instance(instance_arn, params::Dict{String,<:Any})

Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.

Arguments

  • instance_arn: The ARN of the instance of IAM Identity Center under which the operation will run.
source
Main.Sso_Admin.delete_instance_access_control_attribute_configurationMethod
delete_instance_access_control_attribute_configuration(instance_arn)
delete_instance_access_control_attribute_configuration(instance_arn, params::Dict{String,<:Any})

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 in the IAM Identity Center User Guide.

Arguments

  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
source
Main.Sso_Admin.delete_permission_setMethod
delete_permission_set(instance_arn, permission_set_arn)
delete_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Deletes the specified permission set.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set that should be deleted.
source
Main.Sso_Admin.delete_permissions_boundary_from_permission_setMethod
delete_permissions_boundary_from_permission_set(instance_arn, permission_set_arn)
delete_permissions_boundary_from_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Deletes the permissions boundary from a specified PermissionSet.

Arguments

  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
  • permission_set_arn: The ARN of the PermissionSet.
source
Main.Sso_Admin.delete_trusted_token_issuerMethod
delete_trusted_token_issuer(trusted_token_issuer_arn)
delete_trusted_token_issuer(trusted_token_issuer_arn, params::Dict{String,<:Any})

Deletes a trusted token issuer configuration from an instance of IAM Identity Center. Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.

Arguments

  • trusted_token_issuer_arn: Specifies the ARN of the trusted token issuer configuration to delete.
source
Main.Sso_Admin.describe_account_assignment_creation_statusMethod
describe_account_assignment_creation_status(account_assignment_creation_request_id, instance_arn)
describe_account_assignment_creation_status(account_assignment_creation_request_id, instance_arn, params::Dict{String,<:Any})

Describes the status of the assignment creation request.

Arguments

  • account_assignment_creation_request_id: The identifier that is used to track the request operation progress.
  • instance_arn: The ARN of the IAM Identity Center 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.
source
Main.Sso_Admin.describe_account_assignment_deletion_statusMethod
describe_account_assignment_deletion_status(account_assignment_deletion_request_id, instance_arn)
describe_account_assignment_deletion_status(account_assignment_deletion_request_id, instance_arn, params::Dict{String,<:Any})

Describes the status of the assignment deletion request.

Arguments

  • account_assignment_deletion_request_id: The identifier that is used to track the request operation progress.
  • instance_arn: The ARN of the IAM Identity Center 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.
source
Main.Sso_Admin.describe_applicationMethod
describe_application(application_arn)
describe_application(application_arn, params::Dict{String,<:Any})

Retrieves the details of an application associated with an instance of IAM Identity Center.

Arguments

  • application_arn: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
source
Main.Sso_Admin.describe_application_assignmentMethod
describe_application_assignment(application_arn, principal_id, principal_type)
describe_application_assignment(application_arn, principal_id, principal_type, params::Dict{String,<:Any})

Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal.

Arguments

  • application_arn: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
  • principal_id: An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
  • principal_type: The entity type for which the assignment will be created.
source
Main.Sso_Admin.describe_application_providerMethod
describe_application_provider(application_provider_arn)
describe_application_provider(application_provider_arn, params::Dict{String,<:Any})

Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

Arguments

  • application_provider_arn: Specifies the ARN of the application provider for which you want details.
source
Main.Sso_Admin.describe_instanceMethod
describe_instance(instance_arn)
describe_instance(instance_arn, params::Dict{String,<:Any})

Returns the details of an instance of IAM Identity Center. The status can be one of the following: CREATEINPROGRESS - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of ACTIVE. While the instance is in the CREATEINPROGRESS state, you can call only DescribeInstance and DeleteInstance operations. DELETEINPROGRESS - The instance is being deleted. Returns AccessDeniedException after the delete operation completes. ACTIVE - The instance is active.

Arguments

  • instance_arn: The ARN of the instance of IAM Identity Center under which the operation will run.
source
Main.Sso_Admin.describe_instance_access_control_attribute_configurationMethod
describe_instance_access_control_attribute_configuration(instance_arn)
describe_instance_access_control_attribute_configuration(instance_arn, params::Dict{String,<:Any})

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 in the IAM Identity Center User Guide.

Arguments

  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
source
Main.Sso_Admin.describe_permission_setMethod
describe_permission_set(instance_arn, permission_set_arn)
describe_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Gets the details of the permission set.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set.
source
Main.Sso_Admin.describe_permission_set_provisioning_statusMethod
describe_permission_set_provisioning_status(instance_arn, provision_permission_set_request_id)
describe_permission_set_provisioning_status(instance_arn, provision_permission_set_request_id, params::Dict{String,<:Any})

Describes the status for the given permission set provisioning request.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • provision_permission_set_request_id: The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.
source
Main.Sso_Admin.describe_trusted_token_issuerMethod
describe_trusted_token_issuer(trusted_token_issuer_arn)
describe_trusted_token_issuer(trusted_token_issuer_arn, params::Dict{String,<:Any})

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.

Arguments

  • trusted_token_issuer_arn: Specifies the ARN of the trusted token issuer configuration that you want details about.
source
Main.Sso_Admin.detach_customer_managed_policy_reference_from_permission_setMethod
detach_customer_managed_policy_reference_from_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn)
detach_customer_managed_policy_reference_from_permission_set(customer_managed_policy_reference, instance_arn, permission_set_arn, params::Dict{String,<:Any})

Detaches the specified customer managed policy from the specified PermissionSet.

Arguments

  • customer_managed_policy_reference: 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.
  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
  • permission_set_arn: The ARN of the PermissionSet.
source
Main.Sso_Admin.detach_managed_policy_from_permission_setMethod
detach_managed_policy_from_permission_set(instance_arn, managed_policy_arn, permission_set_arn)
detach_managed_policy_from_permission_set(instance_arn, managed_policy_arn, permission_set_arn, params::Dict{String,<:Any})

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

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • managed_policy_arn: The Amazon Web Services managed policy ARN to be detached from a permission set.
  • permission_set_arn: The ARN of the PermissionSet from which the policy should be detached.
source
Main.Sso_Admin.get_application_access_scopeMethod
get_application_access_scope(application_arn, scope)
get_application_access_scope(application_arn, scope, params::Dict{String,<:Any})

Retrieves the authorized targets for an IAM Identity Center access scope for an application.

Arguments

  • application_arn: Specifies the ARN of the application with the access scope that you want to retrieve.
  • scope: Specifies the name of the access scope for which you want the authorized targets.
source
Main.Sso_Admin.get_application_assignment_configurationMethod
get_application_assignment_configuration(application_arn)
get_application_assignment_configuration(application_arn, params::Dict{String,<:Any})

Retrieves the configuration of PutApplicationAssignmentConfiguration.

Arguments

  • application_arn: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
source
Main.Sso_Admin.get_application_authentication_methodMethod
get_application_authentication_method(application_arn, authentication_method_type)
get_application_authentication_method(application_arn, authentication_method_type, params::Dict{String,<:Any})

Retrieves details about an authentication method used by an application.

Arguments

  • application_arn: Specifies the ARN of the application.
  • authentication_method_type: Specifies the type of authentication method for which you want details.
source
Main.Sso_Admin.get_application_grantMethod
get_application_grant(application_arn, grant_type)
get_application_grant(application_arn, grant_type, params::Dict{String,<:Any})

Retrieves details about an application grant.

Arguments

  • application_arn: Specifies the ARN of the application that contains the grant.
  • grant_type: Specifies the type of grant.
source
Main.Sso_Admin.get_inline_policy_for_permission_setMethod
get_inline_policy_for_permission_set(instance_arn, permission_set_arn)
get_inline_policy_for_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Obtains the inline policy assigned to the permission set.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set.
source
Main.Sso_Admin.get_permissions_boundary_for_permission_setMethod
get_permissions_boundary_for_permission_set(instance_arn, permission_set_arn)
get_permissions_boundary_for_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Obtains the permissions boundary for a specified PermissionSet.

Arguments

  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
  • permission_set_arn: The ARN of the PermissionSet.
source
Main.Sso_Admin.list_account_assignment_creation_statusMethod
list_account_assignment_creation_status(instance_arn)
list_account_assignment_creation_status(instance_arn, params::Dict{String,<:Any})

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

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters results based on the passed attribute value.
  • "MaxResults": The maximum number of results to display for the assignment.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_account_assignment_deletion_statusMethod
list_account_assignment_deletion_status(instance_arn)
list_account_assignment_deletion_status(instance_arn, params::Dict{String,<:Any})

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

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters results based on the passed attribute value.
  • "MaxResults": The maximum number of results to display for the assignment.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_account_assignmentsMethod
list_account_assignments(account_id, instance_arn, permission_set_arn)
list_account_assignments(account_id, instance_arn, permission_set_arn, params::Dict{String,<:Any})

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

Arguments

  • account_id: The identifier of the Amazon Web Services account from which to list the assignments.
  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set from which to list assignments.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to display for the assignment.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_account_assignments_for_principalMethod
list_account_assignments_for_principal(instance_arn, principal_id, principal_type)
list_account_assignments_for_principal(instance_arn, principal_id, principal_type, params::Dict{String,<:Any})

Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.

Arguments

  • instance_arn: Specifies the ARN of the instance of IAM Identity Center that contains the principal.
  • principal_id: Specifies the principal for which you want to retrieve the list of account assignments.
  • principal_type: Specifies the type of the principal.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.
  • "MaxResults": Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_accounts_for_provisioned_permission_setMethod
list_accounts_for_provisioned_permission_set(instance_arn, permission_set_arn)
list_accounts_for_provisioned_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

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

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to display for the PermissionSet.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
  • "ProvisioningStatus": The permission set provisioning status for an Amazon Web Services account.
source
Main.Sso_Admin.list_application_access_scopesMethod
list_application_access_scopes(application_arn)
list_application_access_scopes(application_arn, params::Dict{String,<:Any})

Lists the access scopes and authorized targets associated with an application.

Arguments

  • application_arn: Specifies the ARN of the application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_application_assignmentsMethod
list_application_assignments(application_arn)
list_application_assignments(application_arn, params::Dict{String,<:Any})

Lists Amazon Web Services account users that are assigned to an application.

Arguments

  • application_arn: Specifies the ARN of the application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_application_assignments_for_principalMethod
list_application_assignments_for_principal(instance_arn, principal_id, principal_type)
list_application_assignments_for_principal(instance_arn, principal_id, principal_type, params::Dict{String,<:Any})

Lists the applications to which a specified principal is assigned.

Arguments

  • instance_arn: Specifies the instance of IAM Identity Center that contains principal and applications.
  • principal_id: Specifies the unique identifier of the principal for which you want to retrieve its assignments.
  • principal_type: Specifies the type of the principal for which you want to retrieve its assignments.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters the output to include only assignments associated with the application that has the specified ARN.
  • "MaxResults": Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_application_authentication_methodsMethod
list_application_authentication_methods(application_arn)
list_application_authentication_methods(application_arn, params::Dict{String,<:Any})

Lists all of the authentication methods supported by the specified application.

Arguments

  • application_arn: Specifies the ARN of the application with the authentication methods you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_application_grantsMethod
list_application_grants(application_arn)
list_application_grants(application_arn, params::Dict{String,<:Any})

List the grants associated with an application.

Arguments

  • application_arn: Specifies the ARN of the application whose grants you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_application_providersMethod
list_application_providers()
list_application_providers(params::Dict{String,<:Any})

Lists the application providers configured in the IAM Identity Center identity store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_applicationsMethod
list_applications(instance_arn)
list_applications(instance_arn, params::Dict{String,<:Any})

Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account.

Arguments

  • instance_arn: The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters response results.
  • "MaxResults": Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.list_customer_managed_policy_references_in_permission_setMethod
list_customer_managed_policy_references_in_permission_set(instance_arn, permission_set_arn)
list_customer_managed_policy_references_in_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Lists all customer managed policies attached to a specified PermissionSet.

Arguments

  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
  • permission_set_arn: The ARN of the PermissionSet.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to display for the list call.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_instancesMethod
list_instances()
list_instances(params::Dict{String,<:Any})

Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to display for the instance.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_managed_policies_in_permission_setMethod
list_managed_policies_in_permission_set(instance_arn, permission_set_arn)
list_managed_policies_in_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

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

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the PermissionSet whose managed policies will be listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to display for the PermissionSet.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_permission_set_provisioning_statusMethod
list_permission_set_provisioning_status(instance_arn)
list_permission_set_provisioning_status(instance_arn, params::Dict{String,<:Any})

Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters results based on the passed attribute value.
  • "MaxResults": The maximum number of results to display for the assignment.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_permission_setsMethod
list_permission_sets(instance_arn)
list_permission_sets(instance_arn, params::Dict{String,<:Any})

Lists the PermissionSets in an IAM Identity Center instance.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to display for the assignment.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_permission_sets_provisioned_to_accountMethod
list_permission_sets_provisioned_to_account(account_id, instance_arn)
list_permission_sets_provisioned_to_account(account_id, instance_arn, params::Dict{String,<:Any})

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

Arguments

  • account_id: The identifier of the Amazon Web Services account from which to list the assignments.
  • instance_arn: The ARN of the IAM Identity Center 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to display for the assignment.
  • "NextToken": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
  • "ProvisioningStatus": The status object for the permission set provisioning operation.
source
Main.Sso_Admin.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags that are attached to a specified resource.

Arguments

  • resource_arn: The ARN of the resource with the tags to be listed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "InstanceArn": The ARN of the IAM Identity Center 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": The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
source
Main.Sso_Admin.list_trusted_token_issuersMethod
list_trusted_token_issuers(instance_arn)
list_trusted_token_issuers(instance_arn, params::Dict{String,<:Any})

Lists all the trusted token issuers configured in an instance of IAM Identity Center.

Arguments

  • instance_arn: Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
  • "NextToken": Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
source
Main.Sso_Admin.provision_permission_setMethod
provision_permission_set(instance_arn, permission_set_arn, target_type)
provision_permission_set(instance_arn, permission_set_arn, target_type, params::Dict{String,<:Any})

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

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set.
  • target_type: The entity type for which the assignment will be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "TargetId": TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
source
Main.Sso_Admin.put_application_access_scopeMethod
put_application_access_scope(application_arn, scope)
put_application_access_scope(application_arn, scope, params::Dict{String,<:Any})

Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.

Arguments

  • application_arn: Specifies the ARN of the application with the access scope with the targets to add or update.
  • scope: Specifies the name of the access scope to be associated with the specified targets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AuthorizedTargets": Specifies an array list of ARNs that represent the authorized targets for this access scope.
source
Main.Sso_Admin.put_application_assignment_configurationMethod
put_application_assignment_configuration(application_arn, assignment_required)
put_application_assignment_configuration(application_arn, assignment_required, params::Dict{String,<:Any})

Configure how users gain access to an application. If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.

Arguments

  • application_arn: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
  • assignment_required: If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application.
source
Main.Sso_Admin.put_application_authentication_methodMethod
put_application_authentication_method(application_arn, authentication_method, authentication_method_type)
put_application_authentication_method(application_arn, authentication_method, authentication_method_type, params::Dict{String,<:Any})

Adds or updates an authentication method for an application.

Arguments

  • application_arn: Specifies the ARN of the application with the authentication method to add or update.
  • authentication_method: Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the AuthenticationMethodType parameter.
  • authentication_method_type: Specifies the type of the authentication method that you want to add or update.
source
Main.Sso_Admin.put_application_grantMethod
put_application_grant(application_arn, grant, grant_type)
put_application_grant(application_arn, grant, grant_type, params::Dict{String,<:Any})

Adds a grant to an application.

Arguments

  • application_arn: Specifies the ARN of the application to update.
  • grant: Specifies a structure that describes the grant to update.
  • grant_type: Specifies the type of grant to update.
source
Main.Sso_Admin.put_inline_policy_to_permission_setMethod
put_inline_policy_to_permission_set(inline_policy, instance_arn, permission_set_arn)
put_inline_policy_to_permission_set(inline_policy, instance_arn, permission_set_arn, params::Dict{String,<:Any})

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.

Arguments

  • inline_policy: The inline policy to attach to a PermissionSet.
  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set.
source
Main.Sso_Admin.put_permissions_boundary_to_permission_setMethod
put_permissions_boundary_to_permission_set(instance_arn, permission_set_arn, permissions_boundary)
put_permissions_boundary_to_permission_set(instance_arn, permission_set_arn, permissions_boundary, params::Dict{String,<:Any})

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

Arguments

  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
  • permission_set_arn: The ARN of the PermissionSet.
  • permissions_boundary: The permissions boundary that you want to attach to a PermissionSet.
source
Main.Sso_Admin.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Associates a set of tags with a specified resource.

Arguments

  • resource_arn: The ARN of the resource with the tags to be listed.
  • tags: A set of key-value pairs that are used to manage the resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "InstanceArn": The ARN of the IAM Identity Center 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.
source
Main.Sso_Admin.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Disassociates a set of tags from a specified resource.

Arguments

  • resource_arn: The ARN of the resource with the tags to be listed.
  • tag_keys: The keys of tags that are attached to the resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "InstanceArn": The ARN of the IAM Identity Center 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.
source
Main.Sso_Admin.update_applicationMethod
update_application(application_arn)
update_application(application_arn, params::Dict{String,<:Any})

Updates application properties.

Arguments

  • application_arn: Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the .
  • "Name": Specifies the updated name for the application.
  • "PortalOptions": A structure that describes the options for the portal associated with an application.
  • "Status": Specifies whether the application is enabled or disabled.
source
Main.Sso_Admin.update_instanceMethod
update_instance(instance_arn, name)
update_instance(instance_arn, name, params::Dict{String,<:Any})

Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.

Arguments

  • instance_arn: The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
  • name: Updates the instance name.
source
Main.Sso_Admin.update_instance_access_control_attribute_configurationMethod
update_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn)
update_instance_access_control_attribute_configuration(instance_access_control_attribute_configuration, instance_arn, params::Dict{String,<:Any})

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 in the IAM Identity Center User Guide.

Arguments

  • instance_access_control_attribute_configuration: Updates the attributes for your ABAC configuration.
  • instance_arn: The ARN of the IAM Identity Center instance under which the operation will be executed.
source
Main.Sso_Admin.update_permission_setMethod
update_permission_set(instance_arn, permission_set_arn)
update_permission_set(instance_arn, permission_set_arn, params::Dict{String,<:Any})

Updates an existing permission set.

Arguments

  • instance_arn: The ARN of the IAM Identity Center 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.
  • permission_set_arn: The ARN of the permission set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the PermissionSet.
  • "RelayState": Used to redirect users within the application during the federation authentication process.
  • "SessionDuration": The length of time that the application user sessions are valid for in the ISO-8601 standard.
source
Main.Sso_Admin.update_trusted_token_issuerMethod
update_trusted_token_issuer(trusted_token_issuer_arn)
update_trusted_token_issuer(trusted_token_issuer_arn, params::Dict{String,<:Any})

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration. Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.

Arguments

  • trusted_token_issuer_arn: Specifies the ARN of the trusted token issuer configuration that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Name": Specifies the updated name to be applied to the trusted token issuer configuration.
  • "TrustedTokenIssuerConfiguration": Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.
source