Learn R Programming

paws (version 0.2.0)

ssoadmin: AWS Single Sign-On Admin

Description

AWS Single Sign-On Admin

Usage

ssoadmin(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

svc <- ssoadmin(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical"
  )
)

Operations

attach_customer_managed_policy_reference_to_permission_setAttaches the specified customer managed policy to the specified PermissionSet
attach_managed_policy_to_permission_setAttaches an Amazon Web Services managed policy ARN to a permission set
create_account_assignmentAssigns access to a principal for a specified Amazon Web Services account using a specified permission set
create_instance_access_control_attribute_configurationEnables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO instance
create_permission_setCreates a permission set within a specified Amazon Web Services SSO instance
delete_account_assignmentDeletes a principal's access from a specified Amazon Web Services account using a specified permission set
delete_inline_policy_from_permission_setDeletes the inline policy from a specified permission set
delete_instance_access_control_attribute_configurationDisables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO instance and deletes all of the attribute mappings that have been configured
delete_permissions_boundary_from_permission_setDeletes the permissions boundary from a specified PermissionSet
delete_permission_setDeletes the specified permission set
describe_account_assignment_creation_statusDescribes the status of the assignment creation request
describe_account_assignment_deletion_statusDescribes the status of the assignment deletion request
describe_instance_access_control_attribute_configurationReturns the list of Amazon Web Services SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified Amazon Web Services SSO instance
describe_permission_setGets the details of the permission set
describe_permission_set_provisioning_statusDescribes the status for the given permission set provisioning request
detach_customer_managed_policy_reference_from_permission_setDetaches the specified customer managed policy from the specified PermissionSet
detach_managed_policy_from_permission_setDetaches the attached Amazon Web Services managed policy ARN from the specified permission set
get_inline_policy_for_permission_setObtains the inline policy assigned to the permission set
get_permissions_boundary_for_permission_setObtains the permissions boundary for a specified PermissionSet
list_account_assignment_creation_statusLists the status of the Amazon Web Services account assignment creation requests for a specified Amazon Web Services SSO instance
list_account_assignment_deletion_statusLists the status of the Amazon Web Services account assignment deletion requests for a specified Amazon Web Services SSO instance
list_account_assignmentsLists the assignee of the specified Amazon Web Services account with the specified permission set
list_accounts_for_provisioned_permission_setLists all the Amazon Web Services accounts where the specified permission set is provisioned
list_customer_managed_policy_references_in_permission_setLists all customer managed policies attached to a specified PermissionSet
list_instancesLists the Amazon Web Services SSO instances that the caller has access to
list_managed_policies_in_permission_setLists the Amazon Web Services managed policy that is attached to a specified permission set
list_permission_set_provisioning_statusLists the status of the permission set provisioning requests for a specified Amazon Web Services SSO instance
list_permission_setsLists the PermissionSets in an Amazon Web Services SSO instance
list_permission_sets_provisioned_to_accountLists all the permission sets that are provisioned to a specified Amazon Web Services account
list_tags_for_resourceLists the tags that are attached to a specified resource
provision_permission_setThe process by which a specified permission set is provisioned to the specified target
put_inline_policy_to_permission_setAttaches an inline policy to a permission set
put_permissions_boundary_to_permission_setAttaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary
tag_resourceAssociates a set of tags with a specified resource
untag_resourceDisassociates a set of tags from a specified resource
update_instance_access_control_attribute_configurationUpdates the Amazon Web Services SSO identity store attributes that you can use with the Amazon Web Services SSO instance for attributes-based access control (ABAC)
update_permission_setUpdates an existing permission set

Examples

Run this code
if (FALSE) {
svc <- ssoadmin()
svc$attach_customer_managed_policy_reference_to_permission_set(
  Foo = 123
)
}

Run the code above in your browser using DataLab