prowler-sdk-poc
Version:
829 lines • 62.9 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class SSOAdmin extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: SSOAdmin.Types.ClientConfiguration)
config: Config & SSOAdmin.Types.ClientConfiguration;
/**
* Attaches an IAM 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.
*/
attachManagedPolicyToPermissionSet(params: SSOAdmin.Types.AttachManagedPolicyToPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse, AWSError>;
/**
* Attaches an IAM 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.
*/
attachManagedPolicyToPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse, AWSError>;
/**
* 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 Amazon Web Services SSO. 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 SSO-created IAM role. 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.
*/
createAccountAssignment(params: SSOAdmin.Types.CreateAccountAssignmentRequest, callback?: (err: AWSError, data: SSOAdmin.Types.CreateAccountAssignmentResponse) => void): Request<SSOAdmin.Types.CreateAccountAssignmentResponse, AWSError>;
/**
* 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 Amazon Web Services SSO. 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 SSO-created IAM role. 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.
*/
createAccountAssignment(callback?: (err: AWSError, data: SSOAdmin.Types.CreateAccountAssignmentResponse) => void): Request<SSOAdmin.Types.CreateAccountAssignmentResponse, AWSError>;
/**
* Enables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO 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 Amazon Web Services SSO User Guide.
*/
createInstanceAccessControlAttributeConfiguration(params: SSOAdmin.Types.CreateInstanceAccessControlAttributeConfigurationRequest, callback?: (err: AWSError, data: SSOAdmin.Types.CreateInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.CreateInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Enables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO 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 Amazon Web Services SSO User Guide.
*/
createInstanceAccessControlAttributeConfiguration(callback?: (err: AWSError, data: SSOAdmin.Types.CreateInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.CreateInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Creates a permission set within a specified SSO instance. To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment .
*/
createPermissionSet(params: SSOAdmin.Types.CreatePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.CreatePermissionSetResponse) => void): Request<SSOAdmin.Types.CreatePermissionSetResponse, AWSError>;
/**
* Creates a permission set within a specified SSO instance. To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment .
*/
createPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.CreatePermissionSetResponse) => void): Request<SSOAdmin.Types.CreatePermissionSetResponse, AWSError>;
/**
* Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
*/
deleteAccountAssignment(params: SSOAdmin.Types.DeleteAccountAssignmentRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DeleteAccountAssignmentResponse) => void): Request<SSOAdmin.Types.DeleteAccountAssignmentResponse, AWSError>;
/**
* Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
*/
deleteAccountAssignment(callback?: (err: AWSError, data: SSOAdmin.Types.DeleteAccountAssignmentResponse) => void): Request<SSOAdmin.Types.DeleteAccountAssignmentResponse, AWSError>;
/**
* Deletes the inline policy from a specified permission set.
*/
deleteInlinePolicyFromPermissionSet(params: SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse, AWSError>;
/**
* Deletes the inline policy from a specified permission set.
*/
deleteInlinePolicyFromPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse, AWSError>;
/**
* Disables 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. 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 Amazon Web Services SSO User Guide.
*/
deleteInstanceAccessControlAttributeConfiguration(params: SSOAdmin.Types.DeleteInstanceAccessControlAttributeConfigurationRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DeleteInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.DeleteInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Disables 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. 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 Amazon Web Services SSO User Guide.
*/
deleteInstanceAccessControlAttributeConfiguration(callback?: (err: AWSError, data: SSOAdmin.Types.DeleteInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.DeleteInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Deletes the specified permission set.
*/
deletePermissionSet(params: SSOAdmin.Types.DeletePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DeletePermissionSetResponse) => void): Request<SSOAdmin.Types.DeletePermissionSetResponse, AWSError>;
/**
* Deletes the specified permission set.
*/
deletePermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DeletePermissionSetResponse) => void): Request<SSOAdmin.Types.DeletePermissionSetResponse, AWSError>;
/**
* Describes the status of the assignment creation request.
*/
describeAccountAssignmentCreationStatus(params: SSOAdmin.Types.DescribeAccountAssignmentCreationStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Describes the status of the assignment creation request.
*/
describeAccountAssignmentCreationStatus(callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Describes the status of the assignment deletion request.
*/
describeAccountAssignmentDeletionStatus(params: SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Describes the status of the assignment deletion request.
*/
describeAccountAssignmentDeletionStatus(callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Returns 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. 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 Amazon Web Services SSO User Guide.
*/
describeInstanceAccessControlAttributeConfiguration(params: SSOAdmin.Types.DescribeInstanceAccessControlAttributeConfigurationRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribeInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.DescribeInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Returns 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. 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 Amazon Web Services SSO User Guide.
*/
describeInstanceAccessControlAttributeConfiguration(callback?: (err: AWSError, data: SSOAdmin.Types.DescribeInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.DescribeInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Gets the details of the permission set.
*/
describePermissionSet(params: SSOAdmin.Types.DescribePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetResponse, AWSError>;
/**
* Gets the details of the permission set.
*/
describePermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetResponse, AWSError>;
/**
* Describes the status for the given permission set provisioning request.
*/
describePermissionSetProvisioningStatus(params: SSOAdmin.Types.DescribePermissionSetProvisioningStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse, AWSError>;
/**
* Describes the status for the given permission set provisioning request.
*/
describePermissionSetProvisioningStatus(callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse, AWSError>;
/**
* Detaches the attached IAM managed policy ARN from the specified permission set.
*/
detachManagedPolicyFromPermissionSet(params: SSOAdmin.Types.DetachManagedPolicyFromPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse, AWSError>;
/**
* Detaches the attached IAM managed policy ARN from the specified permission set.
*/
detachManagedPolicyFromPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse, AWSError>;
/**
* Obtains the inline policy assigned to the permission set.
*/
getInlinePolicyForPermissionSet(params: SSOAdmin.Types.GetInlinePolicyForPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse) => void): Request<SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse, AWSError>;
/**
* Obtains the inline policy assigned to the permission set.
*/
getInlinePolicyForPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse) => void): Request<SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse, AWSError>;
/**
* Lists the status of the Amazon Web Services account assignment creation requests for a specified SSO instance.
*/
listAccountAssignmentCreationStatus(params: SSOAdmin.Types.ListAccountAssignmentCreationStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Lists the status of the Amazon Web Services account assignment creation requests for a specified SSO instance.
*/
listAccountAssignmentCreationStatus(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Lists the status of the Amazon Web Services account assignment deletion requests for a specified SSO instance.
*/
listAccountAssignmentDeletionStatus(params: SSOAdmin.Types.ListAccountAssignmentDeletionStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Lists the status of the Amazon Web Services account assignment deletion requests for a specified SSO instance.
*/
listAccountAssignmentDeletionStatus(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Lists the assignee of the specified Amazon Web Services account with the specified permission set.
*/
listAccountAssignments(params: SSOAdmin.Types.ListAccountAssignmentsRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentsResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentsResponse, AWSError>;
/**
* Lists the assignee of the specified Amazon Web Services account with the specified permission set.
*/
listAccountAssignments(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentsResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentsResponse, AWSError>;
/**
* Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
*/
listAccountsForProvisionedPermissionSet(params: SSOAdmin.Types.ListAccountsForProvisionedPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse) => void): Request<SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse, AWSError>;
/**
* Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
*/
listAccountsForProvisionedPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse) => void): Request<SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse, AWSError>;
/**
* Lists the SSO instances that the caller has access to.
*/
listInstances(params: SSOAdmin.Types.ListInstancesRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListInstancesResponse) => void): Request<SSOAdmin.Types.ListInstancesResponse, AWSError>;
/**
* Lists the SSO instances that the caller has access to.
*/
listInstances(callback?: (err: AWSError, data: SSOAdmin.Types.ListInstancesResponse) => void): Request<SSOAdmin.Types.ListInstancesResponse, AWSError>;
/**
* Lists the IAM managed policy that is attached to a specified permission set.
*/
listManagedPoliciesInPermissionSet(params: SSOAdmin.Types.ListManagedPoliciesInPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse) => void): Request<SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse, AWSError>;
/**
* Lists the IAM managed policy that is attached to a specified permission set.
*/
listManagedPoliciesInPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse) => void): Request<SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse, AWSError>;
/**
* Lists the status of the permission set provisioning requests for a specified SSO instance.
*/
listPermissionSetProvisioningStatus(params: SSOAdmin.Types.ListPermissionSetProvisioningStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse, AWSError>;
/**
* Lists the status of the permission set provisioning requests for a specified SSO instance.
*/
listPermissionSetProvisioningStatus(callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse, AWSError>;
/**
* Lists the PermissionSets in an SSO instance.
*/
listPermissionSets(params: SSOAdmin.Types.ListPermissionSetsRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsResponse, AWSError>;
/**
* Lists the PermissionSets in an SSO instance.
*/
listPermissionSets(callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsResponse, AWSError>;
/**
* Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
*/
listPermissionSetsProvisionedToAccount(params: SSOAdmin.Types.ListPermissionSetsProvisionedToAccountRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse, AWSError>;
/**
* Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
*/
listPermissionSetsProvisionedToAccount(callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse, AWSError>;
/**
* Lists the tags that are attached to a specified resource.
*/
listTagsForResource(params: SSOAdmin.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListTagsForResourceResponse) => void): Request<SSOAdmin.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags that are attached to a specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: SSOAdmin.Types.ListTagsForResourceResponse) => void): Request<SSOAdmin.Types.ListTagsForResourceResponse, AWSError>;
/**
* The process by which a specified permission set is provisioned to the specified target.
*/
provisionPermissionSet(params: SSOAdmin.Types.ProvisionPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ProvisionPermissionSetResponse) => void): Request<SSOAdmin.Types.ProvisionPermissionSetResponse, AWSError>;
/**
* The process by which a specified permission set is provisioned to the specified target.
*/
provisionPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.ProvisionPermissionSetResponse) => void): Request<SSOAdmin.Types.ProvisionPermissionSetResponse, AWSError>;
/**
* Attaches an IAM 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.
*/
putInlinePolicyToPermissionSet(params: SSOAdmin.Types.PutInlinePolicyToPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse, AWSError>;
/**
* Attaches an IAM 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.
*/
putInlinePolicyToPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse, AWSError>;
/**
* Associates a set of tags with a specified resource.
*/
tagResource(params: SSOAdmin.Types.TagResourceRequest, callback?: (err: AWSError, data: SSOAdmin.Types.TagResourceResponse) => void): Request<SSOAdmin.Types.TagResourceResponse, AWSError>;
/**
* Associates a set of tags with a specified resource.
*/
tagResource(callback?: (err: AWSError, data: SSOAdmin.Types.TagResourceResponse) => void): Request<SSOAdmin.Types.TagResourceResponse, AWSError>;
/**
* Disassociates a set of tags from a specified resource.
*/
untagResource(params: SSOAdmin.Types.UntagResourceRequest, callback?: (err: AWSError, data: SSOAdmin.Types.UntagResourceResponse) => void): Request<SSOAdmin.Types.UntagResourceResponse, AWSError>;
/**
* Disassociates a set of tags from a specified resource.
*/
untagResource(callback?: (err: AWSError, data: SSOAdmin.Types.UntagResourceResponse) => void): Request<SSOAdmin.Types.UntagResourceResponse, AWSError>;
/**
* Updates 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). 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 Amazon Web Services SSO identity store. If a SAML assertion passes any of these attributes, Amazon Web Services SSO replaces the attribute value with the value from the Amazon Web Services SSO identity store. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide.
*/
updateInstanceAccessControlAttributeConfiguration(params: SSOAdmin.Types.UpdateInstanceAccessControlAttributeConfigurationRequest, callback?: (err: AWSError, data: SSOAdmin.Types.UpdateInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.UpdateInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Updates 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). 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 Amazon Web Services SSO identity store. If a SAML assertion passes any of these attributes, Amazon Web Services SSO replaces the attribute value with the value from the Amazon Web Services SSO identity store. For more information about ABAC, see Attribute-Based Access Control in the Amazon Web Services SSO User Guide.
*/
updateInstanceAccessControlAttributeConfiguration(callback?: (err: AWSError, data: SSOAdmin.Types.UpdateInstanceAccessControlAttributeConfigurationResponse) => void): Request<SSOAdmin.Types.UpdateInstanceAccessControlAttributeConfigurationResponse, AWSError>;
/**
* Updates an existing permission set.
*/
updatePermissionSet(params: SSOAdmin.Types.UpdatePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.UpdatePermissionSetResponse) => void): Request<SSOAdmin.Types.UpdatePermissionSetResponse, AWSError>;
/**
* Updates an existing permission set.
*/
updatePermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.UpdatePermissionSetResponse) => void): Request<SSOAdmin.Types.UpdatePermissionSetResponse, AWSError>;
}
declare namespace SSOAdmin {
export interface AccessControlAttribute {
/**
* The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in Amazon Web Services SSO.
*/
Key: AccessControlAttributeKey;
/**
* The value used for mapping a specified attribute to an identity source.
*/
Value: AccessControlAttributeValue;
}
export type AccessControlAttributeKey = string;
export type AccessControlAttributeList = AccessControlAttribute[];
export interface AccessControlAttributeValue {
/**
* The identity source to use when mapping a specified attribute to Amazon Web Services SSO.
*/
Source: AccessControlAttributeValueSourceList;
}
export type AccessControlAttributeValueSource = string;
export type AccessControlAttributeValueSourceList = AccessControlAttributeValueSource[];
export interface AccountAssignment {
/**
* The identifier of the Amazon Web Services account.
*/
AccountId?: AccountId;
/**
* The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
*/
PermissionSetArn?: PermissionSetArn;
/**
* The entity type for which the assignment will be created.
*/
PrincipalType?: PrincipalType;
/**
* An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference.
*/
PrincipalId?: PrincipalId;
}
export type AccountAssignmentList = AccountAssignment[];
export interface AccountAssignmentOperationStatus {
/**
* The status of the permission set provisioning process.
*/
Status?: StatusValues;
/**
* The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
*/
RequestId?: UUId;
/**
* The message that contains an error or exception in case of an operation failure.
*/
FailureReason?: Reason;
/**
* TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
*/
TargetId?: TargetId;
/**
* The entity type for which the assignment will be created.
*/
TargetType?: TargetType;
/**
* The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
*/
PermissionSetArn?: PermissionSetArn;
/**
* The entity type for which the assignment will be created.
*/
PrincipalType?: PrincipalType;
/**
* An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference.
*/
PrincipalId?: PrincipalId;
/**
* The date that the permission set was created.
*/
CreatedDate?: _Date;
}
export type AccountAssignmentOperationStatusList = AccountAssignmentOperationStatusMetadata[];
export interface AccountAssignmentOperationStatusMetadata {
/**
* The status of the permission set provisioning process.
*/
Status?: StatusValues;
/**
* The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
*/
RequestId?: UUId;
/**
* The date that the permission set was created.
*/
CreatedDate?: _Date;
}
export type AccountId = string;
export type AccountList = AccountId[];
export interface AttachManagedPolicyToPermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet that the managed policy should be attached to.
*/
PermissionSetArn: PermissionSetArn;
/**
* The IAM managed policy ARN to be attached to a permission set.
*/
ManagedPolicyArn: ManagedPolicyArn;
}
export interface AttachManagedPolicyToPermissionSetResponse {
}
export interface AttachedManagedPolicy {
/**
* The name of the IAM managed policy.
*/
Name?: Name;
/**
* The ARN of the IAM managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
*/
Arn?: ManagedPolicyArn;
}
export type AttachedManagedPolicyList = AttachedManagedPolicy[];
export interface CreateAccountAssignmentRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
*/
TargetId: TargetId;
/**
* The entity type for which the assignment will be created.
*/
TargetType: TargetType;
/**
* The ARN of the permission set that the admin wants to grant the principal access to.
*/
PermissionSetArn: PermissionSetArn;
/**
* The entity type for which the assignment will be created.
*/
PrincipalType: PrincipalType;
/**
* An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference.
*/
PrincipalId: PrincipalId;
}
export interface CreateAccountAssignmentResponse {
/**
* The status object for the account assignment creation operation.
*/
AccountAssignmentCreationStatus?: AccountAssignmentOperationStatus;
}
export interface CreateInstanceAccessControlAttributeConfigurationRequest {
/**
* The ARN of the SSO instance under which the operation will be executed.
*/
InstanceArn: InstanceArn;
/**
* Specifies the Amazon Web Services SSO 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 Amazon Web Services SSO identity store. If a SAML assertion passes any of these attributes, Amazon Web Services SSO will replace the attribute value with the value from the Amazon Web Services SSO identity store.
*/
InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfiguration;
}
export interface CreateInstanceAccessControlAttributeConfigurationResponse {
}
export interface CreatePermissionSetRequest {
/**
* The name of the PermissionSet.
*/
Name: PermissionSetName;
/**
* The description of the PermissionSet.
*/
Description?: PermissionSetDescription;
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The length of time that the application user sessions are valid in the ISO-8601 standard.
*/
SessionDuration?: Duration;
/**
* Used to redirect users within the application during the federation authentication process.
*/
RelayState?: RelayState;
/**
* The tags to attach to the new PermissionSet.
*/
Tags?: TagList;
}
export interface CreatePermissionSetResponse {
/**
* Defines the level of access on an Amazon Web Services account.
*/
PermissionSet?: PermissionSet;
}
export type _Date = Date;
export interface DeleteAccountAssignmentRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
*/
TargetId: TargetId;
/**
* The entity type for which the assignment will be deleted.
*/
TargetType: TargetType;
/**
* The ARN of the permission set that will be used to remove access.
*/
PermissionSetArn: PermissionSetArn;
/**
* The entity type for which the assignment will be deleted.
*/
PrincipalType: PrincipalType;
/**
* An identifier for an object in Amazon Web Services SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in Amazon Web Services SSO, see the Amazon Web Services SSO Identity Store API Reference.
*/
PrincipalId: PrincipalId;
}
export interface DeleteAccountAssignmentResponse {
/**
* The status object for the account assignment deletion operation.
*/
AccountAssignmentDeletionStatus?: AccountAssignmentOperationStatus;
}
export interface DeleteInlinePolicyFromPermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set that will be used to remove access.
*/
PermissionSetArn: PermissionSetArn;
}
export interface DeleteInlinePolicyFromPermissionSetResponse {
}
export interface DeleteInstanceAccessControlAttributeConfigurationRequest {
/**
* The ARN of the SSO instance under which the operation will be executed.
*/
InstanceArn: InstanceArn;
}
export interface DeleteInstanceAccessControlAttributeConfigurationResponse {
}
export interface DeletePermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set that should be deleted.
*/
PermissionSetArn: PermissionSetArn;
}
export interface DeletePermissionSetResponse {
}
export interface DescribeAccountAssignmentCreationStatusRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The identifier that is used to track the request operation progress.
*/
AccountAssignmentCreationRequestId: UUId;
}
export interface DescribeAccountAssignmentCreationStatusResponse {
/**
* The status object for the account assignment creation operation.
*/
AccountAssignmentCreationStatus?: AccountAssignmentOperationStatus;
}
export interface DescribeAccountAssignmentDeletionStatusRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The identifier that is used to track the request operation progress.
*/
AccountAssignmentDeletionRequestId: UUId;
}
export interface DescribeAccountAssignmentDeletionStatusResponse {
/**
* The status object for the account assignment deletion operation.
*/
AccountAssignmentDeletionStatus?: AccountAssignmentOperationStatus;
}
export interface DescribeInstanceAccessControlAttributeConfigurationRequest {
/**
* The ARN of the SSO instance under which the operation will be executed.
*/
InstanceArn: InstanceArn;
}
export interface DescribeInstanceAccessControlAttributeConfigurationResponse {
/**
* The status of the attribute configuration process.
*/
Status?: InstanceAccessControlAttributeConfigurationStatus;
/**
* Provides more details about the current status of the specified attribute.
*/
StatusReason?: InstanceAccessControlAttributeConfigurationStatusReason;
/**
* Gets the list of Amazon Web Services SSO identity store attributes that have been added to your ABAC configuration.
*/
InstanceAccessControlAttributeConfiguration?: InstanceAccessControlAttributeConfiguration;
}
export interface DescribePermissionSetProvisioningStatusRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.
*/
ProvisionPermissionSetRequestId: UUId;
}
export interface DescribePermissionSetProvisioningStatusResponse {
/**
* The status object for the permission set provisioning operation.
*/
PermissionSetProvisioningStatus?: PermissionSetProvisioningStatus;
}
export interface DescribePermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set.
*/
PermissionSetArn: PermissionSetArn;
}
export interface DescribePermissionSetResponse {
/**
* Describes the level of access on an Amazon Web Services account.
*/
PermissionSet?: PermissionSet;
}
export interface DetachManagedPolicyFromPermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet from which the policy should be detached.
*/
PermissionSetArn: PermissionSetArn;
/**
* The IAM managed policy ARN to be attached to a permission set.
*/
ManagedPolicyArn: ManagedPolicyArn;
}
export interface DetachManagedPolicyFromPermissionSetResponse {
}
export type Duration = string;
export type GeneralArn = string;
export interface GetInlinePolicyForPermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set.
*/
PermissionSetArn: PermissionSetArn;
}
export interface GetInlinePolicyForPermissionSetResponse {
/**
* The IAM inline policy that is attached to the permission set.
*/
InlinePolicy?: PermissionSetPolicyDocument;
}
export type Id = string;
export interface InstanceAccessControlAttributeConfiguration {
/**
* Lists the attributes that are configured for ABAC in the specified Amazon Web Services SSO instance.
*/
AccessControlAttributes: AccessControlAttributeList;
}
export type InstanceAccessControlAttributeConfigurationStatus = "ENABLED"|"CREATION_IN_PROGRESS"|"CREATION_FAILED"|string;
export type InstanceAccessControlAttributeConfigurationStatusReason = string;
export type InstanceArn = string;
export type InstanceList = InstanceMetadata[];
export interface InstanceMetadata {
/**
* The ARN of the SSO 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.
*/
InstanceArn?: InstanceArn;
/**
* The identifier of the identity store that is connected to the SSO instance.
*/
IdentityStoreId?: Id;
}
export interface ListAccountAssignmentCreationStatusRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
/**
* Filters results based on the passed attribute value.
*/
Filter?: OperationStatusFilter;
}
export interface ListAccountAssignmentCreationStatusResponse {
/**
* The status object for the account assignment creation operation.
*/
AccountAssignmentsCreationStatus?: AccountAssignmentOperationStatusList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountAssignmentDeletionStatusRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
/**
* Filters results based on the passed attribute value.
*/
Filter?: OperationStatusFilter;
}
export interface ListAccountAssignmentDeletionStatusResponse {
/**
* The status object for the account assignment deletion operation.
*/
AccountAssignmentsDeletionStatus?: AccountAssignmentOperationStatusList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountAssignmentsRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The identifier of the Amazon Web Services account from which to list the assignments.
*/
AccountId: TargetId;
/**
* The ARN of the permission set from which to list assignments.
*/
PermissionSetArn: PermissionSetArn;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountAssignmentsResponse {
/**
* The list of assignments that match the input Amazon Web Services account and permission set.
*/
AccountAssignments?: AccountAssignmentList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountsForProvisionedPermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.
*/
PermissionSetArn: PermissionSetArn;
/**
* The permission set provisioning status for an Amazon Web Services account.
*/
ProvisioningStatus?: ProvisioningStatus;
/**
* The maximum number of results to display for the PermissionSet.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountsForProvisionedPermissionSetResponse {
/**
* The list of Amazon Web Services AccountIds.
*/
AccountIds?: AccountList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListInstancesRequest {
/**
* The maximum number of results to display for the instance.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListInstancesResponse {
/**
* Lists the SSO instances that the caller has access to.
*/
Instances?: InstanceList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListManagedPoliciesInPermissionSetRequest {
/**
* The ARN of the SSO 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.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet whose managed policies will be listed.
*/
PermissionSetArn: PermissionSetArn;
/**
* The maximum number of results to display for the PermissionSet.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListManagedPoliciesInPermissionSetResponse {
/**
* The array of the AttachedManagedPolicy data type object.
*/
AttachedManagedPolicies?: AttachedManagedPolicyList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subseq