Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

SSOAdmin

import { SSOAdmin } from "https://aws-api.deno.dev/v0.4/services/ssoadmin.ts?docs=full";
class SSOAdmin {
constructor(apiFactory: client.ApiFactory);
async attachCustomerManagedPolicyReferenceToPermissionSet(params: AttachCustomerManagedPolicyReferenceToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async attachManagedPolicyToPermissionSet(params: AttachManagedPolicyToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async createAccountAssignment(params: CreateAccountAssignmentRequest, opts?: client.RequestOptions): Promise<CreateAccountAssignmentResponse>;
async createInstanceAccessControlAttributeConfiguration(params: CreateInstanceAccessControlAttributeConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async createPermissionSet(params: CreatePermissionSetRequest, opts?: client.RequestOptions): Promise<CreatePermissionSetResponse>;
async deleteAccountAssignment(params: DeleteAccountAssignmentRequest, opts?: client.RequestOptions): Promise<DeleteAccountAssignmentResponse>;
async deleteInlinePolicyFromPermissionSet(params: DeleteInlinePolicyFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async deleteInstanceAccessControlAttributeConfiguration(params: DeleteInstanceAccessControlAttributeConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async deletePermissionsBoundaryFromPermissionSet(params: DeletePermissionsBoundaryFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async deletePermissionSet(params: DeletePermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async describeAccountAssignmentCreationStatus(params: DescribeAccountAssignmentCreationStatusRequest, opts?: client.RequestOptions): Promise<DescribeAccountAssignmentCreationStatusResponse>;
async describeAccountAssignmentDeletionStatus(params: DescribeAccountAssignmentDeletionStatusRequest, opts?: client.RequestOptions): Promise<DescribeAccountAssignmentDeletionStatusResponse>;
async describePermissionSet(params: DescribePermissionSetRequest, opts?: client.RequestOptions): Promise<DescribePermissionSetResponse>;
async describePermissionSetProvisioningStatus(params: DescribePermissionSetProvisioningStatusRequest, opts?: client.RequestOptions): Promise<DescribePermissionSetProvisioningStatusResponse>;
async detachCustomerManagedPolicyReferenceFromPermissionSet(params: DetachCustomerManagedPolicyReferenceFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async detachManagedPolicyFromPermissionSet(params: DetachManagedPolicyFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async getInlinePolicyForPermissionSet(params: GetInlinePolicyForPermissionSetRequest, opts?: client.RequestOptions): Promise<GetInlinePolicyForPermissionSetResponse>;
async getPermissionsBoundaryForPermissionSet(params: GetPermissionsBoundaryForPermissionSetRequest, opts?: client.RequestOptions): Promise<GetPermissionsBoundaryForPermissionSetResponse>;
async listAccountAssignmentCreationStatus(params: ListAccountAssignmentCreationStatusRequest, opts?: client.RequestOptions): Promise<ListAccountAssignmentCreationStatusResponse>;
async listAccountAssignmentDeletionStatus(params: ListAccountAssignmentDeletionStatusRequest, opts?: client.RequestOptions): Promise<ListAccountAssignmentDeletionStatusResponse>;
async listAccountAssignments(params: ListAccountAssignmentsRequest, opts?: client.RequestOptions): Promise<ListAccountAssignmentsResponse>;
async listAccountsForProvisionedPermissionSet(params: ListAccountsForProvisionedPermissionSetRequest, opts?: client.RequestOptions): Promise<ListAccountsForProvisionedPermissionSetResponse>;
async listInstances(params?: ListInstancesRequest, opts?: client.RequestOptions): Promise<ListInstancesResponse>;
async listManagedPoliciesInPermissionSet(params: ListManagedPoliciesInPermissionSetRequest, opts?: client.RequestOptions): Promise<ListManagedPoliciesInPermissionSetResponse>;
async listPermissionSetProvisioningStatus(params: ListPermissionSetProvisioningStatusRequest, opts?: client.RequestOptions): Promise<ListPermissionSetProvisioningStatusResponse>;
async listPermissionSets(params: ListPermissionSetsRequest, opts?: client.RequestOptions): Promise<ListPermissionSetsResponse>;
async listPermissionSetsProvisionedToAccount(params: ListPermissionSetsProvisionedToAccountRequest, opts?: client.RequestOptions): Promise<ListPermissionSetsProvisionedToAccountResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async provisionPermissionSet(params: ProvisionPermissionSetRequest, opts?: client.RequestOptions): Promise<ProvisionPermissionSetResponse>;
async putInlinePolicyToPermissionSet(params: PutInlinePolicyToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async putPermissionsBoundaryToPermissionSet(params: PutPermissionsBoundaryToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateInstanceAccessControlAttributeConfiguration(params: UpdateInstanceAccessControlAttributeConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async updatePermissionSet(params: UpdatePermissionSetRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new SSOAdmin(apiFactory: client.ApiFactory)
[src]

§Methods

§
attachCustomerManagedPolicyReferenceToPermissionSet(params: AttachCustomerManagedPolicyReferenceToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Attaches the specified customer managed policy to the specified "PermissionSet".

§
attachManagedPolicyToPermissionSet(params: AttachManagedPolicyToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Attaches an AWS managed policy ARN to a permission set.

Note: 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.

§
createAccountAssignment(params: CreateAccountAssignmentRequest, opts?: client.RequestOptions): Promise<CreateAccountAssignmentResponse>
[src]

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

Note: The term principal here refers to a user or group that is defined in IAM Identity Center.

Note: 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.

Note: After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request.

§
createInstanceAccessControlAttributeConfiguration(params: CreateInstanceAccessControlAttributeConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

Note: After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created.

§
createPermissionSet(params: CreatePermissionSetRequest, opts?: client.RequestOptions): Promise<CreatePermissionSetResponse>
[src]

Creates a permission set within a specified IAM Identity Center instance.

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

§
deleteAccountAssignment(params: DeleteAccountAssignmentRequest, opts?: client.RequestOptions): Promise<DeleteAccountAssignmentResponse>
[src]

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

Note: After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment deletion request.

§
deleteInlinePolicyFromPermissionSet(params: DeleteInlinePolicyFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the inline policy from a specified permission set.

§
deleteInstanceAccessControlAttributeConfiguration(params: DeleteInstanceAccessControlAttributeConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
deletePermissionsBoundaryFromPermissionSet(params: DeletePermissionsBoundaryFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the permissions boundary from a specified "PermissionSet".

§
deletePermissionSet(params: DeletePermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified permission set.

§
describeAccountAssignmentCreationStatus(params: DescribeAccountAssignmentCreationStatusRequest, opts?: client.RequestOptions): Promise<DescribeAccountAssignmentCreationStatusResponse>
[src]

Describes the status of the assignment creation request.

§
describeAccountAssignmentDeletionStatus(params: DescribeAccountAssignmentDeletionStatusRequest, opts?: client.RequestOptions): Promise<DescribeAccountAssignmentDeletionStatusResponse>
[src]

Describes the status of the assignment deletion request.

§
describeInstanceAccessControlAttributeConfiguration(params: DescribeInstanceAccessControlAttributeConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeInstanceAccessControlAttributeConfigurationResponse>
[src]

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.

§
describePermissionSet(params: DescribePermissionSetRequest, opts?: client.RequestOptions): Promise<DescribePermissionSetResponse>
[src]

Gets the details of the permission set.

§
describePermissionSetProvisioningStatus(params: DescribePermissionSetProvisioningStatusRequest, opts?: client.RequestOptions): Promise<DescribePermissionSetProvisioningStatusResponse>
[src]

Describes the status for the given permission set provisioning request.

§
detachCustomerManagedPolicyReferenceFromPermissionSet(params: DetachCustomerManagedPolicyReferenceFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Detaches the specified customer managed policy from the specified "PermissionSet".

§
detachManagedPolicyFromPermissionSet(params: DetachManagedPolicyFromPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
getInlinePolicyForPermissionSet(params: GetInlinePolicyForPermissionSetRequest, opts?: client.RequestOptions): Promise<GetInlinePolicyForPermissionSetResponse>
[src]

Obtains the inline policy assigned to the permission set.

§
getPermissionsBoundaryForPermissionSet(params: GetPermissionsBoundaryForPermissionSetRequest, opts?: client.RequestOptions): Promise<GetPermissionsBoundaryForPermissionSetResponse>
[src]

Obtains the permissions boundary for a specified "PermissionSet".

§
listAccountAssignmentCreationStatus(params: ListAccountAssignmentCreationStatusRequest, opts?: client.RequestOptions): Promise<ListAccountAssignmentCreationStatusResponse>
[src]

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

§
listAccountAssignmentDeletionStatus(params: ListAccountAssignmentDeletionStatusRequest, opts?: client.RequestOptions): Promise<ListAccountAssignmentDeletionStatusResponse>
[src]

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

§
listAccountAssignments(params: ListAccountAssignmentsRequest, opts?: client.RequestOptions): Promise<ListAccountAssignmentsResponse>
[src]

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

§
listAccountsForProvisionedPermissionSet(params: ListAccountsForProvisionedPermissionSetRequest, opts?: client.RequestOptions): Promise<ListAccountsForProvisionedPermissionSetResponse>
[src]

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

§
listCustomerManagedPolicyReferencesInPermissionSet(params: ListCustomerManagedPolicyReferencesInPermissionSetRequest, opts?: client.RequestOptions): Promise<ListCustomerManagedPolicyReferencesInPermissionSetResponse>
[src]

Lists all customer managed policies attached to a specified "PermissionSet".

§
listInstances(params?: ListInstancesRequest, opts?: client.RequestOptions): Promise<ListInstancesResponse>
[src]

Lists the IAM Identity Center instances that the caller has access to.

§
listManagedPoliciesInPermissionSet(params: ListManagedPoliciesInPermissionSetRequest, opts?: client.RequestOptions): Promise<ListManagedPoliciesInPermissionSetResponse>
[src]

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

§
listPermissionSetProvisioningStatus(params: ListPermissionSetProvisioningStatusRequest, opts?: client.RequestOptions): Promise<ListPermissionSetProvisioningStatusResponse>
[src]

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

§
listPermissionSets(params: ListPermissionSetsRequest, opts?: client.RequestOptions): Promise<ListPermissionSetsResponse>
[src]

Lists the "PermissionSet"s in an IAM Identity Center instance.

§
listPermissionSetsProvisionedToAccount(params: ListPermissionSetsProvisionedToAccountRequest, opts?: client.RequestOptions): Promise<ListPermissionSetsProvisionedToAccountResponse>
[src]

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

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

Lists the tags that are attached to a specified resource.

§
provisionPermissionSet(params: ProvisionPermissionSetRequest, opts?: client.RequestOptions): Promise<ProvisionPermissionSetResponse>
[src]

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

§
putInlinePolicyToPermissionSet(params: PutInlinePolicyToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Attaches an inline policy to a permission set.

Note: 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.

§
putPermissionsBoundaryToPermissionSet(params: PutPermissionsBoundaryToPermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Attaches an AWS managed or customer managed policy to the specified "PermissionSet" as a permissions boundary.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Associates a set of tags with a specified resource.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Disassociates a set of tags from a specified resource.

§
updateInstanceAccessControlAttributeConfiguration(params: UpdateInstanceAccessControlAttributeConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
updatePermissionSet(params: UpdatePermissionSetRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates an existing permission set.

§Static Properties