Class: Aws::SSOAdmin::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SSOAdmin::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb
Overview
An API client for SSOAdmin. To construct a client, you need to configure a :region and :credentials.
client = Aws::SSOAdmin::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_region(params = {}) ⇒ Types::AddRegionResponse
Adds a Region to an IAM Identity Center instance.
-
#attach_customer_managed_policy_reference_to_permission_set(params = {}) ⇒ Struct
Attaches the specified customer managed policy to the specified PermissionSet.
-
#attach_managed_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed policy ARN to a permission set.
-
#create_account_assignment(params = {}) ⇒ Types::CreateAccountAssignmentResponse
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
-
#create_application_assignment(params = {}) ⇒ Struct
Grant application access to a user or group.
-
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
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.
-
#create_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance.
-
#create_permission_set(params = {}) ⇒ Types::CreatePermissionSetResponse
Creates a permission set within a specified IAM Identity Center instance.
-
#create_trusted_token_issuer(params = {}) ⇒ Types::CreateTrustedTokenIssuerResponse
Creates a connection to a trusted token issuer in an instance of IAM Identity Center.
-
#delete_account_assignment(params = {}) ⇒ Types::DeleteAccountAssignmentResponse
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
-
#delete_application(params = {}) ⇒ Struct
Deletes the association with the application.
-
#delete_application_access_scope(params = {}) ⇒ Struct
Deletes an IAM Identity Center access scope from an application.
-
#delete_application_assignment(params = {}) ⇒ Struct
Revoke application access to an application by deleting application assignments for a user or group.
-
#delete_application_authentication_method(params = {}) ⇒ Struct
Deletes an authentication method from an application.
-
#delete_application_grant(params = {}) ⇒ Struct
Deletes a grant from an application.
-
#delete_inline_policy_from_permission_set(params = {}) ⇒ Struct
Deletes the inline policy from a specified permission set.
-
#delete_instance(params = {}) ⇒ Struct
Deletes the instance of IAM Identity Center.
-
#delete_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
-
#delete_permission_set(params = {}) ⇒ Struct
Deletes the specified permission set.
-
#delete_permissions_boundary_from_permission_set(params = {}) ⇒ Struct
Deletes the permissions boundary from a specified PermissionSet.
-
#delete_trusted_token_issuer(params = {}) ⇒ Struct
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
-
#describe_account_assignment_creation_status(params = {}) ⇒ Types::DescribeAccountAssignmentCreationStatusResponse
Describes the status of the assignment creation request.
-
#describe_account_assignment_deletion_status(params = {}) ⇒ Types::DescribeAccountAssignmentDeletionStatusResponse
Describes the status of the assignment deletion request.
-
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Retrieves the details of an application associated with an instance of IAM Identity Center.
-
#describe_application_assignment(params = {}) ⇒ Types::DescribeApplicationAssignmentResponse
Retrieves a direct assignment of a user or group to an application.
-
#describe_application_provider(params = {}) ⇒ Types::DescribeApplicationProviderResponse
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.
-
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
Returns the details of an instance of IAM Identity Center.
-
#describe_instance_access_control_attribute_configuration(params = {}) ⇒ Types::DescribeInstanceAccessControlAttributeConfigurationResponse
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.
-
#describe_permission_set(params = {}) ⇒ Types::DescribePermissionSetResponse
Gets the details of the permission set.
-
#describe_permission_set_provisioning_status(params = {}) ⇒ Types::DescribePermissionSetProvisioningStatusResponse
Describes the status for the given permission set provisioning request.
-
#describe_region(params = {}) ⇒ Types::DescribeRegionResponse
Retrieves details about a specific Region enabled in an IAM Identity Center instance.
-
#describe_trusted_token_issuer(params = {}) ⇒ Types::DescribeTrustedTokenIssuerResponse
Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center.
-
#detach_customer_managed_policy_reference_from_permission_set(params = {}) ⇒ Struct
Detaches the specified customer managed policy from the specified PermissionSet.
-
#detach_managed_policy_from_permission_set(params = {}) ⇒ Struct
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
-
#get_application_access_scope(params = {}) ⇒ Types::GetApplicationAccessScopeResponse
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
-
#get_application_assignment_configuration(params = {}) ⇒ Types::GetApplicationAssignmentConfigurationResponse
Retrieves the configuration of PutApplicationAssignmentConfiguration.
-
#get_application_authentication_method(params = {}) ⇒ Types::GetApplicationAuthenticationMethodResponse
Retrieves details about an authentication method used by an application.
-
#get_application_grant(params = {}) ⇒ Types::GetApplicationGrantResponse
Retrieves details about an application grant.
-
#get_application_session_configuration(params = {}) ⇒ Types::GetApplicationSessionConfigurationResponse
Retrieves the session configuration for an application in IAM Identity Center.
-
#get_inline_policy_for_permission_set(params = {}) ⇒ Types::GetInlinePolicyForPermissionSetResponse
Obtains the inline policy assigned to the permission set.
-
#get_permissions_boundary_for_permission_set(params = {}) ⇒ Types::GetPermissionsBoundaryForPermissionSetResponse
Obtains the permissions boundary for a specified PermissionSet.
-
#list_account_assignment_creation_status(params = {}) ⇒ Types::ListAccountAssignmentCreationStatusResponse
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
-
#list_account_assignment_deletion_status(params = {}) ⇒ Types::ListAccountAssignmentDeletionStatusResponse
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
-
#list_account_assignments(params = {}) ⇒ Types::ListAccountAssignmentsResponse
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
-
#list_account_assignments_for_principal(params = {}) ⇒ Types::ListAccountAssignmentsForPrincipalResponse
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
-
#list_accounts_for_provisioned_permission_set(params = {}) ⇒ Types::ListAccountsForProvisionedPermissionSetResponse
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
-
#list_application_access_scopes(params = {}) ⇒ Types::ListApplicationAccessScopesResponse
Lists the access scopes and authorized targets associated with an application.
-
#list_application_assignments(params = {}) ⇒ Types::ListApplicationAssignmentsResponse
Lists Amazon Web Services account users that are assigned to an application.
-
#list_application_assignments_for_principal(params = {}) ⇒ Types::ListApplicationAssignmentsForPrincipalResponse
Lists the applications to which a specified principal is assigned.
-
#list_application_authentication_methods(params = {}) ⇒ Types::ListApplicationAuthenticationMethodsResponse
Lists all of the authentication methods supported by the specified application.
-
#list_application_grants(params = {}) ⇒ Types::ListApplicationGrantsResponse
List the grants associated with an application.
-
#list_application_providers(params = {}) ⇒ Types::ListApplicationProvidersResponse
Lists the application providers configured in the IAM Identity Center identity store.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists all applications associated with the instance of IAM Identity Center.
-
#list_customer_managed_policy_references_in_permission_set(params = {}) ⇒ Types::ListCustomerManagedPolicyReferencesInPermissionSetResponse
Lists all customer managed policies attached to a specified PermissionSet.
-
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
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.
-
#list_managed_policies_in_permission_set(params = {}) ⇒ Types::ListManagedPoliciesInPermissionSetResponse
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
-
#list_permission_set_provisioning_status(params = {}) ⇒ Types::ListPermissionSetProvisioningStatusResponse
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
-
#list_permission_sets(params = {}) ⇒ Types::ListPermissionSetsResponse
Lists the PermissionSets in an IAM Identity Center instance.
-
#list_permission_sets_provisioned_to_account(params = {}) ⇒ Types::ListPermissionSetsProvisionedToAccountResponse
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
-
#list_regions(params = {}) ⇒ Types::ListRegionsResponse
Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are attached to a specified resource.
-
#list_trusted_token_issuers(params = {}) ⇒ Types::ListTrustedTokenIssuersResponse
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
-
#provision_permission_set(params = {}) ⇒ Types::ProvisionPermissionSetResponse
The process by which a specified permission set is provisioned to the specified target.
-
#put_application_access_scope(params = {}) ⇒ Struct
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
-
#put_application_assignment_configuration(params = {}) ⇒ Struct
Configure how users gain access to an application.
-
#put_application_authentication_method(params = {}) ⇒ Struct
Adds or updates an authentication method for an application.
-
#put_application_grant(params = {}) ⇒ Struct
Creates a configuration for an application to use grants.
-
#put_application_session_configuration(params = {}) ⇒ Struct
Updates the session configuration for an application in IAM Identity Center.
-
#put_inline_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an inline policy to a permission set.
-
#put_permissions_boundary_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
-
#remove_region(params = {}) ⇒ Types::RemoveRegionResponse
Removes an additional Region from an IAM Identity Center instance.
-
#tag_resource(params = {}) ⇒ Struct
Associates a set of tags with a specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Disassociates a set of tags from a specified resource.
-
#update_application(params = {}) ⇒ Struct
Updates application properties.
-
#update_instance(params = {}) ⇒ Struct
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
-
#update_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC).
-
#update_permission_set(params = {}) ⇒ Struct
Updates an existing permission set.
-
#update_trusted_token_issuer(params = {}) ⇒ Struct
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#add_region(params = {}) ⇒ Types::AddRegionResponse
Adds a Region to an IAM Identity Center instance. This operation initiates an asynchronous workflow to replicate the IAM Identity Center instance to the target Region. The Region status is set to ADDING at first and changes to ACTIVE when the workflow completes.
To use this operation, your IAM Identity Center instance and the target Region must meet the requirements described in the IAM Identity Center User Guide.
The following actions are related to AddRegion:
545 546 547 548 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 545 def add_region(params = {}, = {}) req = build_request(:add_region, params) req.send_request() end |
#attach_customer_managed_policy_reference_to_permission_set(params = {}) ⇒ Struct
Attaches the specified customer managed policy to the specified PermissionSet.
582 583 584 585 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 582 def (params = {}, = {}) req = build_request(:attach_customer_managed_policy_reference_to_permission_set, params) req.send_request() end |
#attach_managed_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed policy ARN to a permission set.
ProvisionPermissionSet after
this operation. Calling ProvisionPermissionSet applies the
corresponding IAM policy updates to all assigned accounts.
626 627 628 629 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 626 def (params = {}, = {}) req = build_request(:attach_managed_policy_to_permission_set, params) req.send_request() end |
#create_account_assignment(params = {}) ⇒ Types::CreateAccountAssignmentResponse
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
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.
DescribeAccountAssignmentCreationStatus to describe the status of an
assignment creation request.
715 716 717 718 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 715 def create_account_assignment(params = {}, = {}) req = build_request(:create_account_assignment, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
828 829 830 831 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 828 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_application_assignment(params = {}) ⇒ Struct
Grant application access to a user or group.
866 867 868 869 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 866 def create_application_assignment(params = {}, = {}) req = build_request(:create_application_assignment, params) req.send_request() end |
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
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.
935 936 937 938 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 935 def create_instance(params = {}, = {}) req = build_request(:create_instance, params) req.send_request() end |
#create_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
DescribeInstanceAccessControlAttributeConfiguration to validate that
InstanceAccessControlAttributeConfiguration was created.
989 990 991 992 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 989 def create_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:create_instance_access_control_attribute_configuration, params) req.send_request() end |
#create_permission_set(params = {}) ⇒ Types::CreatePermissionSetResponse
Creates a permission set within a specified IAM Identity Center instance.
CreateAccountAssignment.
1059 1060 1061 1062 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1059 def (params = {}, = {}) req = build_request(:create_permission_set, params) req.send_request() end |
#create_trusted_token_issuer(params = {}) ⇒ Types::CreateTrustedTokenIssuerResponse
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.
1150 1151 1152 1153 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1150 def create_trusted_token_issuer(params = {}, = {}) req = build_request(:create_trusted_token_issuer, params) req.send_request() end |
#delete_account_assignment(params = {}) ⇒ Types::DeleteAccountAssignmentResponse
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
DescribeAccountAssignmentDeletionStatus to describe the status of an
assignment deletion request.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1223 def delete_account_assignment(params = {}, = {}) req = build_request(:delete_account_assignment, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes the association with the application. The connected service resource still exists.
1249 1250 1251 1252 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1249 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_application_access_scope(params = {}) ⇒ Struct
Deletes an IAM Identity Center access scope from an application.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1275 def delete_application_access_scope(params = {}, = {}) req = build_request(:delete_application_access_scope, params) req.send_request() end |
#delete_application_assignment(params = {}) ⇒ Struct
Revoke application access to an application by deleting application assignments for a user or group.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1314 def delete_application_assignment(params = {}, = {}) req = build_request(:delete_application_assignment, params) req.send_request() end |
#delete_application_authentication_method(params = {}) ⇒ Struct
Deletes an authentication method from an application.
1342 1343 1344 1345 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1342 def delete_application_authentication_method(params = {}, = {}) req = build_request(:delete_application_authentication_method, params) req.send_request() end |
#delete_application_grant(params = {}) ⇒ Struct
Deletes a grant from an application.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1368 def delete_application_grant(params = {}, = {}) req = build_request(:delete_application_grant, params) req.send_request() end |
#delete_inline_policy_from_permission_set(params = {}) ⇒ Struct
Deletes the inline policy from a specified permission set.
1398 1399 1400 1401 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1398 def (params = {}, = {}) req = build_request(:delete_inline_policy_from_permission_set, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Struct
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.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1424 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#delete_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
1454 1455 1456 1457 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1454 def delete_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:delete_instance_access_control_attribute_configuration, params) req.send_request() end |
#delete_permission_set(params = {}) ⇒ Struct
Deletes the specified permission set.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1484 def (params = {}, = {}) req = build_request(:delete_permission_set, params) req.send_request() end |
#delete_permissions_boundary_from_permission_set(params = {}) ⇒ Struct
Deletes the permissions boundary from a specified PermissionSet.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1511 def (params = {}, = {}) req = build_request(:delete_permissions_boundary_from_permission_set, params) req.send_request() end |
#delete_trusted_token_issuer(params = {}) ⇒ Struct
Deletes a trusted token issuer configuration from an instance of IAM Identity Center.
1540 1541 1542 1543 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1540 def delete_trusted_token_issuer(params = {}, = {}) req = build_request(:delete_trusted_token_issuer, params) req.send_request() end |
#describe_account_assignment_creation_status(params = {}) ⇒ Types::DescribeAccountAssignmentCreationStatusResponse
Describes the status of the assignment creation request.
1584 1585 1586 1587 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1584 def describe_account_assignment_creation_status(params = {}, = {}) req = build_request(:describe_account_assignment_creation_status, params) req.send_request() end |
#describe_account_assignment_deletion_status(params = {}) ⇒ Types::DescribeAccountAssignmentDeletionStatusResponse
Describes the status of the assignment deletion request.
1628 1629 1630 1631 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1628 def describe_account_assignment_deletion_status(params = {}, = {}) req = build_request(:describe_account_assignment_deletion_status, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Retrieves the details of an application associated with an instance of IAM Identity Center.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1682 def describe_application(params = {}, = {}) req = build_request(:describe_application, params) req.send_request() end |
#describe_application_assignment(params = {}) ⇒ Types::DescribeApplicationAssignmentResponse
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.
1737 1738 1739 1740 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1737 def describe_application_assignment(params = {}, = {}) req = build_request(:describe_application_assignment, params) req.send_request() end |
#describe_application_provider(params = {}) ⇒ Types::DescribeApplicationProviderResponse
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.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1778 def describe_application_provider(params = {}, = {}) req = build_request(:describe_application_provider, params) req.send_request() end |
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
Returns the details of an instance of IAM Identity Center. The status can be one of the following:
CREATE_IN_PROGRESS- The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status ofACTIVE. While the instance is in theCREATE_IN_PROGRESSstate, you can call only DescribeInstance and DeleteInstance operations.DELETE_IN_PROGRESS- The instance is being deleted. ReturnsAccessDeniedExceptionafter the delete operation completes.ACTIVE- The instance is active.
1856 1857 1858 1859 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1856 def describe_instance(params = {}, = {}) req = build_request(:describe_instance, params) req.send_request() end |
#describe_instance_access_control_attribute_configuration(params = {}) ⇒ Types::DescribeInstanceAccessControlAttributeConfigurationResponse
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.
1898 1899 1900 1901 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1898 def describe_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:describe_instance_access_control_attribute_configuration, params) req.send_request() end |
#describe_permission_set(params = {}) ⇒ Types::DescribePermissionSetResponse
Gets the details of the permission set.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1939 def (params = {}, = {}) req = build_request(:describe_permission_set, params) req.send_request() end |
#describe_permission_set_provisioning_status(params = {}) ⇒ Types::DescribePermissionSetProvisioningStatusResponse
Describes the status for the given permission set provisioning request.
1982 1983 1984 1985 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 1982 def (params = {}, = {}) req = build_request(:describe_permission_set_provisioning_status, params) req.send_request() end |
#describe_region(params = {}) ⇒ Types::DescribeRegionResponse
Retrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status (ACTIVE, ADDING, or REMOVING), the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of the IAM Identity Center instance.
The following actions are related to DescribeRegion:
2040 2041 2042 2043 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2040 def describe_region(params = {}, = {}) req = build_request(:describe_region, params) req.send_request() end |
#describe_trusted_token_issuer(params = {}) ⇒ Types::DescribeTrustedTokenIssuerResponse
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.
2082 2083 2084 2085 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2082 def describe_trusted_token_issuer(params = {}, = {}) req = build_request(:describe_trusted_token_issuer, params) req.send_request() end |
#detach_customer_managed_policy_reference_from_permission_set(params = {}) ⇒ Struct
Detaches the specified customer managed policy from the specified PermissionSet.
2119 2120 2121 2122 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2119 def (params = {}, = {}) req = build_request(:detach_customer_managed_policy_reference_from_permission_set, params) req.send_request() end |
#detach_managed_policy_from_permission_set(params = {}) ⇒ Struct
Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.
2155 2156 2157 2158 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2155 def (params = {}, = {}) req = build_request(:detach_managed_policy_from_permission_set, params) req.send_request() end |
#get_application_access_scope(params = {}) ⇒ Types::GetApplicationAccessScopeResponse
Retrieves the authorized targets for an IAM Identity Center access scope for an application.
2193 2194 2195 2196 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2193 def get_application_access_scope(params = {}, = {}) req = build_request(:get_application_access_scope, params) req.send_request() end |
#get_application_assignment_configuration(params = {}) ⇒ Types::GetApplicationAssignmentConfigurationResponse
Retrieves the configuration of PutApplicationAssignmentConfiguration.
2224 2225 2226 2227 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2224 def get_application_assignment_configuration(params = {}, = {}) req = build_request(:get_application_assignment_configuration, params) req.send_request() end |
#get_application_authentication_method(params = {}) ⇒ Types::GetApplicationAuthenticationMethodResponse
Retrieves details about an authentication method used by an application.
2258 2259 2260 2261 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2258 def get_application_authentication_method(params = {}, = {}) req = build_request(:get_application_authentication_method, params) req.send_request() end |
#get_application_grant(params = {}) ⇒ Types::GetApplicationGrantResponse
Retrieves details about an application grant.
2295 2296 2297 2298 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2295 def get_application_grant(params = {}, = {}) req = build_request(:get_application_grant, params) req.send_request() end |
#get_application_session_configuration(params = {}) ⇒ Types::GetApplicationSessionConfigurationResponse
Retrieves the session configuration for an application in IAM Identity Center.
The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2331 def get_application_session_configuration(params = {}, = {}) req = build_request(:get_application_session_configuration, params) req.send_request() end |
#get_inline_policy_for_permission_set(params = {}) ⇒ Types::GetInlinePolicyForPermissionSetResponse
Obtains the inline policy assigned to the permission set.
2367 2368 2369 2370 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2367 def (params = {}, = {}) req = build_request(:get_inline_policy_for_permission_set, params) req.send_request() end |
#get_permissions_boundary_for_permission_set(params = {}) ⇒ Types::GetPermissionsBoundaryForPermissionSetResponse
Obtains the permissions boundary for a specified PermissionSet.
2402 2403 2404 2405 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2402 def (params = {}, = {}) req = build_request(:get_permissions_boundary_for_permission_set, params) req.send_request() end |
#list_account_assignment_creation_status(params = {}) ⇒ Types::ListAccountAssignmentCreationStatusResponse
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2457 def list_account_assignment_creation_status(params = {}, = {}) req = build_request(:list_account_assignment_creation_status, params) req.send_request() end |
#list_account_assignment_deletion_status(params = {}) ⇒ Types::ListAccountAssignmentDeletionStatusResponse
Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2512 def list_account_assignment_deletion_status(params = {}, = {}) req = build_request(:list_account_assignment_deletion_status, params) req.send_request() end |
#list_account_assignments(params = {}) ⇒ Types::ListAccountAssignmentsResponse
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2571 def list_account_assignments(params = {}, = {}) req = build_request(:list_account_assignments, params) req.send_request() end |
#list_account_assignments_for_principal(params = {}) ⇒ Types::ListAccountAssignmentsForPrincipalResponse
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2647 2648 2649 2650 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2647 def list_account_assignments_for_principal(params = {}, = {}) req = build_request(:list_account_assignments_for_principal, params) req.send_request() end |
#list_accounts_for_provisioned_permission_set(params = {}) ⇒ Types::ListAccountsForProvisionedPermissionSetResponse
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2704 def (params = {}, = {}) req = build_request(:list_accounts_for_provisioned_permission_set, params) req.send_request() end |
#list_application_access_scopes(params = {}) ⇒ Types::ListApplicationAccessScopesResponse
Lists the access scopes and authorized targets associated with an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2759 2760 2761 2762 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2759 def list_application_access_scopes(params = {}, = {}) req = build_request(:list_application_access_scopes, params) req.send_request() end |
#list_application_assignments(params = {}) ⇒ Types::ListApplicationAssignmentsResponse
Lists Amazon Web Services account users that are assigned to an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2814 2815 2816 2817 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2814 def list_application_assignments(params = {}, = {}) req = build_request(:list_application_assignments, params) req.send_request() end |
#list_application_assignments_for_principal(params = {}) ⇒ Types::ListApplicationAssignmentsForPrincipalResponse
Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2892 2893 2894 2895 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2892 def list_application_assignments_for_principal(params = {}, = {}) req = build_request(:list_application_assignments_for_principal, params) req.send_request() end |
#list_application_authentication_methods(params = {}) ⇒ Types::ListApplicationAuthenticationMethodsResponse
Lists all of the authentication methods supported by the specified application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2935 2936 2937 2938 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2935 def list_application_authentication_methods(params = {}, = {}) req = build_request(:list_application_authentication_methods, params) req.send_request() end |
#list_application_grants(params = {}) ⇒ Types::ListApplicationGrantsResponse
List the grants associated with an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2982 2983 2984 2985 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 2982 def list_application_grants(params = {}, = {}) req = build_request(:list_application_grants, params) req.send_request() end |
#list_application_providers(params = {}) ⇒ Types::ListApplicationProvidersResponse
Lists the application providers configured in the IAM Identity Center identity store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3038 3039 3040 3041 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3038 def list_application_providers(params = {}, = {}) req = build_request(:list_application_providers, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists all applications associated with the instance of IAM Identity
Center. When listing applications for an organization instance in the
management account, member accounts must use the applicationAccount
parameter to filter the list to only applications created from that
account. When listing applications for an account instance in the same
member account, a filter is not required.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3118 3119 3120 3121 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3118 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_customer_managed_policy_references_in_permission_set(params = {}) ⇒ Types::ListCustomerManagedPolicyReferencesInPermissionSetResponse
Lists all customer managed policies attached to a specified PermissionSet.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3167 3168 3169 3170 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3167 def (params = {}, = {}) req = build_request(:list_customer_managed_policy_references_in_permission_set, params) req.send_request() end |
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3233 3234 3235 3236 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3233 def list_instances(params = {}, = {}) req = build_request(:list_instances, params) req.send_request() end |
#list_managed_policies_in_permission_set(params = {}) ⇒ Types::ListManagedPoliciesInPermissionSetResponse
Lists the Amazon Web Services managed policy that is attached to a specified permission set.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3285 3286 3287 3288 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3285 def (params = {}, = {}) req = build_request(:list_managed_policies_in_permission_set, params) req.send_request() end |
#list_permission_set_provisioning_status(params = {}) ⇒ Types::ListPermissionSetProvisioningStatusResponse
Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3340 3341 3342 3343 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3340 def (params = {}, = {}) req = build_request(:list_permission_set_provisioning_status, params) req.send_request() end |
#list_permission_sets(params = {}) ⇒ Types::ListPermissionSetsResponse
Lists the PermissionSets in an IAM Identity Center instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3386 3387 3388 3389 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3386 def (params = {}, = {}) req = build_request(:list_permission_sets, params) req.send_request() end |
#list_permission_sets_provisioned_to_account(params = {}) ⇒ Types::ListPermissionSetsProvisionedToAccountResponse
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3442 3443 3444 3445 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3442 def (params = {}, = {}) req = build_request(:list_permission_sets_provisioned_to_account, params) req.send_request() end |
#list_regions(params = {}) ⇒ Types::ListRegionsResponse
Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status.
The following actions are related to ListRegions:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3504 3505 3506 3507 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3504 def list_regions(params = {}, = {}) req = build_request(:list_regions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are attached to a specified resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3551 3552 3553 3554 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3551 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_trusted_token_issuers(params = {}) ⇒ Types::ListTrustedTokenIssuersResponse
Lists all the trusted token issuers configured in an instance of IAM Identity Center.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3607 3608 3609 3610 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3607 def list_trusted_token_issuers(params = {}, = {}) req = build_request(:list_trusted_token_issuers, params) req.send_request() end |
#provision_permission_set(params = {}) ⇒ Types::ProvisionPermissionSetResponse
The process by which a specified permission set is provisioned to the specified target.
3658 3659 3660 3661 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3658 def (params = {}, = {}) req = build_request(:provision_permission_set, params) req.send_request() end |
#put_application_access_scope(params = {}) ⇒ Struct
Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
3692 3693 3694 3695 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3692 def put_application_access_scope(params = {}, = {}) req = build_request(:put_application_access_scope, params) req.send_request() end |
#put_application_assignment_configuration(params = {}) ⇒ Struct
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.
3738 3739 3740 3741 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3738 def put_application_assignment_configuration(params = {}, = {}) req = build_request(:put_application_assignment_configuration, params) req.send_request() end |
#put_application_authentication_method(params = {}) ⇒ Struct
Adds or updates an authentication method for an application.
3777 3778 3779 3780 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3777 def put_application_authentication_method(params = {}, = {}) req = build_request(:put_application_authentication_method, params) req.send_request() end |
#put_application_grant(params = {}) ⇒ Struct
Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:
Requester - The application requesting access to Amazon Web Services resources.
Subject - Typically the user that is requesting access to Amazon Web Services resources.
Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.
JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.
Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.
Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.
- Authorization server - IAM Identity Center requests tokens.
User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479.
Use cases
Connecting to custom applications.
Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.
3878 3879 3880 3881 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3878 def put_application_grant(params = {}, = {}) req = build_request(:put_application_grant, params) req.send_request() end |
#put_application_session_configuration(params = {}) ⇒ Struct
Updates the session configuration for an application in IAM Identity Center.
The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.
3912 3913 3914 3915 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3912 def put_application_session_configuration(params = {}, = {}) req = build_request(:put_application_session_configuration, params) req.send_request() end |
#put_inline_policy_to_permission_set(params = {}) ⇒ Struct
Attaches an inline policy to a permission set.
ProvisionPermissionSet after
this action to apply the corresponding IAM policy updates to all
assigned accounts.
3953 3954 3955 3956 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3953 def (params = {}, = {}) req = build_request(:put_inline_policy_to_permission_set, params) req.send_request() end |
#put_permissions_boundary_to_permission_set(params = {}) ⇒ Struct
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
3991 3992 3993 3994 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 3991 def (params = {}, = {}) req = build_request(:put_permissions_boundary_to_permission_set, params) req.send_request() end |
#remove_region(params = {}) ⇒ Types::RemoveRegionResponse
Removes an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The request must be made from the primary Region. The target Region cannot be the primary Region, and no other add or remove Region workflows can be in progress.
The following actions are related to RemoveRegion:
4046 4047 4048 4049 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4046 def remove_region(params = {}, = {}) req = build_request(:remove_region, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates a set of tags with a specified resource.
4085 4086 4087 4088 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4085 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Disassociates a set of tags from a specified resource.
4119 4120 4121 4122 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4119 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Struct
Updates application properties.
4166 4167 4168 4169 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4166 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_instance(params = {}) ⇒ Struct
Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.
In a single UpdateInstance request, you can perform only one of the
following operations:
Update the encryption configuration of the instance by specifying
EncryptionConfiguration.Enable permission sets for the instance by specifying
PermissionSetsEnabled.Update the network configuration of the instance by specifying
NetworkConfiguration.
A request that specifies more than one of EncryptionConfiguration,
PermissionSetsEnabled, and NetworkConfiguration returns a
ValidationException. To perform more than one of these operations,
call UpdateInstance separately for each. The calls can be made in
parallel.
4256 4257 4258 4259 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4256 def update_instance(params = {}, = {}) req = build_request(:update_instance, params) req.send_request() end |
#update_instance_access_control_attribute_configuration(params = {}) ⇒ Struct
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.
4302 4303 4304 4305 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4302 def update_instance_access_control_attribute_configuration(params = {}, = {}) req = build_request(:update_instance_access_control_attribute_configuration, params) req.send_request() end |
#update_permission_set(params = {}) ⇒ Struct
Updates an existing permission set.
4346 4347 4348 4349 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4346 def (params = {}, = {}) req = build_request(:update_permission_set, params) req.send_request() end |
#update_trusted_token_issuer(params = {}) ⇒ Struct
Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.
4394 4395 4396 4397 |
# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/client.rb', line 4394 def update_trusted_token_issuer(params = {}, = {}) req = build_request(:update_trusted_token_issuer, params) req.send_request() end |