AWS Single Sign-On Admin 2020-07-20
- Client: Aws\SSOAdmin\SSOAdminClient
- Service ID: sso-admin
- Version: 2020-07-20
This page describes the parameters and results for the operations of the AWS Single Sign-On Admin (2020-07-20), and shows how to use the Aws\SSOAdmin\SSOAdminClient object to call the described operations. This documentation is specific to the 2020-07-20 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AttachManagedPolicyToPermissionSet ( array $params = [] )
Attaches an IAM managed policy ARN to a permission set.
- CreateAccountAssignment ( array $params = [] )
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
- CreateInstanceAccessControlAttributeConfiguration ( array $params = [] )
Enables the attributes-based access control (ABAC) feature for the specified Amazon Web Services SSO instance.
- CreatePermissionSet ( array $params = [] )
Creates a permission set within a specified SSO instance.
- DeleteAccountAssignment ( array $params = [] )
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
- DeleteInlinePolicyFromPermissionSet ( array $params = [] )
Deletes the inline policy from a specified permission set.
- DeleteInstanceAccessControlAttributeConfiguration ( array $params = [] )
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.
- DeletePermissionSet ( array $params = [] )
Deletes the specified permission set.
- DescribeAccountAssignmentCreationStatus ( array $params = [] )
Describes the status of the assignment creation request.
- DescribeAccountAssignmentDeletionStatus ( array $params = [] )
Describes the status of the assignment deletion request.
- DescribeInstanceAccessControlAttributeConfiguration ( array $params = [] )
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.
- DescribePermissionSet ( array $params = [] )
Gets the details of the permission set.
- DescribePermissionSetProvisioningStatus ( array $params = [] )
Describes the status for the given permission set provisioning request.
- DetachManagedPolicyFromPermissionSet ( array $params = [] )
Detaches the attached IAM managed policy ARN from the specified permission set.
- GetInlinePolicyForPermissionSet ( array $params = [] )
Obtains the inline policy assigned to the permission set.
- ListAccountAssignmentCreationStatus ( array $params = [] )
Lists the status of the Amazon Web Services account assignment creation requests for a specified SSO instance.
- ListAccountAssignmentDeletionStatus ( array $params = [] )
Lists the status of the Amazon Web Services account assignment deletion requests for a specified SSO instance.
- ListAccountAssignments ( array $params = [] )
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
- ListAccountsForProvisionedPermissionSet ( array $params = [] )
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
- ListInstances ( array $params = [] )
Lists the SSO instances that the caller has access to.
- ListManagedPoliciesInPermissionSet ( array $params = [] )
Lists the IAM managed policy that is attached to a specified permission set.
- ListPermissionSetProvisioningStatus ( array $params = [] )
Lists the status of the permission set provisioning requests for a specified SSO instance.
- ListPermissionSets ( array $params = [] )
Lists the PermissionSets in an SSO instance.
- ListPermissionSetsProvisionedToAccount ( array $params = [] )
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
- ListTagsForResource ( array $params = [] )
Lists the tags that are attached to a specified resource.
- ProvisionPermissionSet ( array $params = [] )
The process by which a specified permission set is provisioned to the specified target.
- PutInlinePolicyToPermissionSet ( array $params = [] )
Attaches an IAM inline policy to a permission set.
- TagResource ( array $params = [] )
Associates a set of tags with a specified resource.
- UntagResource ( array $params = [] )
Disassociates a set of tags from a specified resource.
- UpdateInstanceAccessControlAttributeConfiguration ( array $params = [] )
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).
- UpdatePermissionSet ( array $params = [] )
Updates an existing permission set.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AttachManagedPolicyToPermissionSet
$result = $client->attachManagedPolicyToPermissionSet([/* ... */]); $promise = $client->attachManagedPolicyToPermissionSetAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->attachManagedPolicyToPermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'ManagedPolicyArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- ManagedPolicyArn
-
- Required: Yes
- Type: string
The IAM managed policy ARN to be attached to a permission set.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the PermissionSet that the managed policy should be attached to.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
ServiceQuotaExceededException:
Indicates that the principal has crossed the permitted number of resources that can be created.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
CreateAccountAssignment
$result = $client->createAccountAssignment([/* ... */]); $promise = $client->createAccountAssignmentAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createAccountAssignment([
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
'PrincipalId' => '<string>', // REQUIRED
'PrincipalType' => 'USER|GROUP', // REQUIRED
'TargetId' => '<string>', // REQUIRED
'TargetType' => 'AWS_ACCOUNT', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set that the admin wants to grant the principal access to.
- PrincipalId
-
- Required: Yes
- Type: string
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.
- PrincipalType
-
- Required: Yes
- Type: string
The entity type for which the assignment will be created.
- TargetId
-
- Required: Yes
- Type: string
TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
- TargetType
-
- Required: Yes
- Type: string
The entity type for which the assignment will be created.
Result Syntax
[
'AccountAssignmentCreationStatus' => [
'CreatedDate' => <DateTime>,
'FailureReason' => '<string>',
'PermissionSetArn' => '<string>',
'PrincipalId' => '<string>',
'PrincipalType' => 'USER|GROUP',
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
'TargetId' => '<string>',
'TargetType' => 'AWS_ACCOUNT',
],
]
Result Details
Members
- AccountAssignmentCreationStatus
-
- Type: AccountAssignmentOperationStatus structure
The status object for the account assignment creation operation.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
ServiceQuotaExceededException:
Indicates that the principal has crossed the permitted number of resources that can be created.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
CreateInstanceAccessControlAttributeConfiguration
$result = $client->createInstanceAccessControlAttributeConfiguration([/* ... */]); $promise = $client->createInstanceAccessControlAttributeConfigurationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createInstanceAccessControlAttributeConfiguration([
'InstanceAccessControlAttributeConfiguration' => [ // REQUIRED
'AccessControlAttributes' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'Source' => ['<string>', ...], // REQUIRED
],
],
// ...
],
],
'InstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceAccessControlAttributeConfiguration
-
- Required: Yes
- Type: InstanceAccessControlAttributeConfiguration structure
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.
- InstanceArn
-
- Required: Yes
- Type: string
The ARN of the SSO instance under which the operation will be executed.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
You do not have sufficient access to perform this action.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
Indicates that a requested resource is not found.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
CreatePermissionSet
$result = $client->createPermissionSet([/* ... */]); $promise = $client->createPermissionSetAsync([/* ... */]);
Creates a permission set within a specified SSO instance.
To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment .
Parameter Syntax
$result = $client->createPermissionSet([
'Description' => '<string>',
'InstanceArn' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'RelayState' => '<string>',
'SessionDuration' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Description
-
- Type: string
The description of the PermissionSet.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- Name
-
- Required: Yes
- Type: string
The name of the PermissionSet.
- RelayState
-
- Type: string
Used to redirect users within the application during the federation authentication process.
- SessionDuration
-
- Type: string
The length of time that the application user sessions are valid in the ISO-8601 standard.
- Tags
-
- Type: Array of Tag structures
The tags to attach to the new PermissionSet.
Result Syntax
[
'PermissionSet' => [
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'Name' => '<string>',
'PermissionSetArn' => '<string>',
'RelayState' => '<string>',
'SessionDuration' => '<string>',
],
]
Result Details
Members
- PermissionSet
-
- Type: PermissionSet structure
Defines the level of access on an Amazon Web Services account.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
ServiceQuotaExceededException:
Indicates that the principal has crossed the permitted number of resources that can be created.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
DeleteAccountAssignment
$result = $client->deleteAccountAssignment([/* ... */]); $promise = $client->deleteAccountAssignmentAsync([/* ... */]);
Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.
Parameter Syntax
$result = $client->deleteAccountAssignment([
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
'PrincipalId' => '<string>', // REQUIRED
'PrincipalType' => 'USER|GROUP', // REQUIRED
'TargetId' => '<string>', // REQUIRED
'TargetType' => 'AWS_ACCOUNT', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set that will be used to remove access.
- PrincipalId
-
- Required: Yes
- Type: string
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.
- PrincipalType
-
- Required: Yes
- Type: string
The entity type for which the assignment will be deleted.
- TargetId
-
- Required: Yes
- Type: string
TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
- TargetType
-
- Required: Yes
- Type: string
The entity type for which the assignment will be deleted.
Result Syntax
[
'AccountAssignmentDeletionStatus' => [
'CreatedDate' => <DateTime>,
'FailureReason' => '<string>',
'PermissionSetArn' => '<string>',
'PrincipalId' => '<string>',
'PrincipalType' => 'USER|GROUP',
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
'TargetId' => '<string>',
'TargetType' => 'AWS_ACCOUNT',
],
]
Result Details
Members
- AccountAssignmentDeletionStatus
-
- Type: AccountAssignmentOperationStatus structure
The status object for the account assignment deletion operation.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
DeleteInlinePolicyFromPermissionSet
$result = $client->deleteInlinePolicyFromPermissionSet([/* ... */]); $promise = $client->deleteInlinePolicyFromPermissionSetAsync([/* ... */]);
Deletes the inline policy from a specified permission set.
Parameter Syntax
$result = $client->deleteInlinePolicyFromPermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set that will be used to remove access.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
DeleteInstanceAccessControlAttributeConfiguration
$result = $client->deleteInstanceAccessControlAttributeConfiguration([/* ... */]); $promise = $client->deleteInstanceAccessControlAttributeConfigurationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteInstanceAccessControlAttributeConfiguration([
'InstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
You do not have sufficient access to perform this action.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
Indicates that a requested resource is not found.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
DeletePermissionSet
$result = $client->deletePermissionSet([/* ... */]); $promise = $client->deletePermissionSetAsync([/* ... */]);
Deletes the specified permission set.
Parameter Syntax
$result = $client->deletePermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set that should be deleted.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
DescribeAccountAssignmentCreationStatus
$result = $client->describeAccountAssignmentCreationStatus([/* ... */]); $promise = $client->describeAccountAssignmentCreationStatusAsync([/* ... */]);
Describes the status of the assignment creation request.
Parameter Syntax
$result = $client->describeAccountAssignmentCreationStatus([
'AccountAssignmentCreationRequestId' => '<string>', // REQUIRED
'InstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AccountAssignmentCreationRequestId
-
- Required: Yes
- Type: string
The identifier that is used to track the request operation progress.
- InstanceArn
-
- Required: Yes
- Type: string
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.
Result Syntax
[
'AccountAssignmentCreationStatus' => [
'CreatedDate' => <DateTime>,
'FailureReason' => '<string>',
'PermissionSetArn' => '<string>',
'PrincipalId' => '<string>',
'PrincipalType' => 'USER|GROUP',
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
'TargetId' => '<string>',
'TargetType' => 'AWS_ACCOUNT',
],
]
Result Details
Members
- AccountAssignmentCreationStatus
-
- Type: AccountAssignmentOperationStatus structure
The status object for the account assignment creation operation.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
DescribeAccountAssignmentDeletionStatus
$result = $client->describeAccountAssignmentDeletionStatus([/* ... */]); $promise = $client->describeAccountAssignmentDeletionStatusAsync([/* ... */]);
Describes the status of the assignment deletion request.
Parameter Syntax
$result = $client->describeAccountAssignmentDeletionStatus([
'AccountAssignmentDeletionRequestId' => '<string>', // REQUIRED
'InstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AccountAssignmentDeletionRequestId
-
- Required: Yes
- Type: string
The identifier that is used to track the request operation progress.
- InstanceArn
-
- Required: Yes
- Type: string
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.
Result Syntax
[
'AccountAssignmentDeletionStatus' => [
'CreatedDate' => <DateTime>,
'FailureReason' => '<string>',
'PermissionSetArn' => '<string>',
'PrincipalId' => '<string>',
'PrincipalType' => 'USER|GROUP',
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
'TargetId' => '<string>',
'TargetType' => 'AWS_ACCOUNT',
],
]
Result Details
Members
- AccountAssignmentDeletionStatus
-
- Type: AccountAssignmentOperationStatus structure
The status object for the account assignment deletion operation.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
DescribeInstanceAccessControlAttributeConfiguration
$result = $client->describeInstanceAccessControlAttributeConfiguration([/* ... */]); $promise = $client->describeInstanceAccessControlAttributeConfigurationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->describeInstanceAccessControlAttributeConfiguration([
'InstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'InstanceAccessControlAttributeConfiguration' => [
'AccessControlAttributes' => [
[
'Key' => '<string>',
'Value' => [
'Source' => ['<string>', ...],
],
],
// ...
],
],
'Status' => 'ENABLED|CREATION_IN_PROGRESS|CREATION_FAILED',
'StatusReason' => '<string>',
]
Result Details
Members
- InstanceAccessControlAttributeConfiguration
-
- Type: InstanceAccessControlAttributeConfiguration structure
Gets the list of Amazon Web Services SSO identity store attributes that have been added to your ABAC configuration.
- Status
-
- Type: string
The status of the attribute configuration process.
- StatusReason
-
- Type: string
Provides more details about the current status of the specified attribute.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
You do not have sufficient access to perform this action.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
DescribePermissionSet
$result = $client->describePermissionSet([/* ... */]); $promise = $client->describePermissionSetAsync([/* ... */]);
Gets the details of the permission set.
Parameter Syntax
$result = $client->describePermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set.
Result Syntax
[
'PermissionSet' => [
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'Name' => '<string>',
'PermissionSetArn' => '<string>',
'RelayState' => '<string>',
'SessionDuration' => '<string>',
],
]
Result Details
Members
- PermissionSet
-
- Type: PermissionSet structure
Describes the level of access on an Amazon Web Services account.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
DescribePermissionSetProvisioningStatus
$result = $client->describePermissionSetProvisioningStatus([/* ... */]); $promise = $client->describePermissionSetProvisioningStatusAsync([/* ... */]);
Describes the status for the given permission set provisioning request.
Parameter Syntax
$result = $client->describePermissionSetProvisioningStatus([
'InstanceArn' => '<string>', // REQUIRED
'ProvisionPermissionSetRequestId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- ProvisionPermissionSetRequestId
-
- Required: Yes
- Type: string
The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.
Result Syntax
[
'PermissionSetProvisioningStatus' => [
'AccountId' => '<string>',
'CreatedDate' => <DateTime>,
'FailureReason' => '<string>',
'PermissionSetArn' => '<string>',
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
]
Result Details
Members
- PermissionSetProvisioningStatus
-
- Type: PermissionSetProvisioningStatus structure
The status object for the permission set provisioning operation.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
DetachManagedPolicyFromPermissionSet
$result = $client->detachManagedPolicyFromPermissionSet([/* ... */]); $promise = $client->detachManagedPolicyFromPermissionSetAsync([/* ... */]);
Detaches the attached IAM managed policy ARN from the specified permission set.
Parameter Syntax
$result = $client->detachManagedPolicyFromPermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'ManagedPolicyArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- ManagedPolicyArn
-
- Required: Yes
- Type: string
The IAM managed policy ARN to be attached to a permission set.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the PermissionSet from which the policy should be detached.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
GetInlinePolicyForPermissionSet
$result = $client->getInlinePolicyForPermissionSet([/* ... */]); $promise = $client->getInlinePolicyForPermissionSetAsync([/* ... */]);
Obtains the inline policy assigned to the permission set.
Parameter Syntax
$result = $client->getInlinePolicyForPermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set.
Result Syntax
[
'InlinePolicy' => '<string>',
]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListAccountAssignmentCreationStatus
$result = $client->listAccountAssignmentCreationStatus([/* ... */]); $promise = $client->listAccountAssignmentCreationStatusAsync([/* ... */]);
Lists the status of the Amazon Web Services account assignment creation requests for a specified SSO instance.
Parameter Syntax
$result = $client->listAccountAssignmentCreationStatus([
'Filter' => [
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filter
-
- Type: OperationStatusFilter structure
Filters results based on the passed attribute value.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the assignment.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Result Syntax
[
'AccountAssignmentsCreationStatus' => [
[
'CreatedDate' => <DateTime>,
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AccountAssignmentsCreationStatus
-
- Type: Array of AccountAssignmentOperationStatusMetadata structures
The status object for the account assignment creation operation.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListAccountAssignmentDeletionStatus
$result = $client->listAccountAssignmentDeletionStatus([/* ... */]); $promise = $client->listAccountAssignmentDeletionStatusAsync([/* ... */]);
Lists the status of the Amazon Web Services account assignment deletion requests for a specified SSO instance.
Parameter Syntax
$result = $client->listAccountAssignmentDeletionStatus([
'Filter' => [
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filter
-
- Type: OperationStatusFilter structure
Filters results based on the passed attribute value.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the assignment.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Result Syntax
[
'AccountAssignmentsDeletionStatus' => [
[
'CreatedDate' => <DateTime>,
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AccountAssignmentsDeletionStatus
-
- Type: Array of AccountAssignmentOperationStatusMetadata structures
The status object for the account assignment deletion operation.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListAccountAssignments
$result = $client->listAccountAssignments([/* ... */]); $promise = $client->listAccountAssignmentsAsync([/* ... */]);
Lists the assignee of the specified Amazon Web Services account with the specified permission set.
Parameter Syntax
$result = $client->listAccountAssignments([
'AccountId' => '<string>', // REQUIRED
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The identifier of the Amazon Web Services account from which to list the assignments.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the assignment.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set from which to list assignments.
Result Syntax
[
'AccountAssignments' => [
[
'AccountId' => '<string>',
'PermissionSetArn' => '<string>',
'PrincipalId' => '<string>',
'PrincipalType' => 'USER|GROUP',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AccountAssignments
-
- Type: Array of AccountAssignment structures
The list of assignments that match the input Amazon Web Services account and permission set.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListAccountsForProvisionedPermissionSet
$result = $client->listAccountsForProvisionedPermissionSet([/* ... */]); $promise = $client->listAccountsForProvisionedPermissionSetAsync([/* ... */]);
Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
Parameter Syntax
$result = $client->listAccountsForProvisionedPermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PermissionSetArn' => '<string>', // REQUIRED
'ProvisioningStatus' => 'LATEST_PERMISSION_SET_PROVISIONED|LATEST_PERMISSION_SET_NOT_PROVISIONED',
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the PermissionSet.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.
- ProvisioningStatus
-
- Type: string
The permission set provisioning status for an Amazon Web Services account.
Result Syntax
[
'AccountIds' => ['<string>', ...],
'NextToken' => '<string>',
]
Result Details
Members
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListInstances
$result = $client->listInstances([/* ... */]); $promise = $client->listInstancesAsync([/* ... */]);
Lists the SSO instances that the caller has access to.
Parameter Syntax
$result = $client->listInstances([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Instances' => [
[
'IdentityStoreId' => '<string>',
'InstanceArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Instances
-
- Type: Array of InstanceMetadata structures
Lists the SSO instances that the caller has access to.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Errors
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
You do not have sufficient access to perform this action.
-
The request failed because it contains a syntax error.
ListManagedPoliciesInPermissionSet
$result = $client->listManagedPoliciesInPermissionSet([/* ... */]); $promise = $client->listManagedPoliciesInPermissionSetAsync([/* ... */]);
Lists the IAM managed policy that is attached to a specified permission set.
Parameter Syntax
$result = $client->listManagedPoliciesInPermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the PermissionSet.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the PermissionSet whose managed policies will be listed.
Result Syntax
[
'AttachedManagedPolicies' => [
[
'Arn' => '<string>',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- AttachedManagedPolicies
-
- Type: Array of AttachedManagedPolicy structures
The array of the AttachedManagedPolicy data type object.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListPermissionSetProvisioningStatus
$result = $client->listPermissionSetProvisioningStatus([/* ... */]); $promise = $client->listPermissionSetProvisioningStatusAsync([/* ... */]);
Lists the status of the permission set provisioning requests for a specified SSO instance.
Parameter Syntax
$result = $client->listPermissionSetProvisioningStatus([
'Filter' => [
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filter
-
- Type: OperationStatusFilter structure
Filters results based on the passed attribute value.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the assignment.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Result Syntax
[
'NextToken' => '<string>',
'PermissionSetsProvisioningStatus' => [
[
'CreatedDate' => <DateTime>,
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
- PermissionSetsProvisioningStatus
-
- Type: Array of PermissionSetProvisioningStatusMetadata structures
The status object for the permission set provisioning operation.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListPermissionSets
$result = $client->listPermissionSets([/* ... */]); $promise = $client->listPermissionSetsAsync([/* ... */]);
Lists the PermissionSets in an SSO instance.
Parameter Syntax
$result = $client->listPermissionSets([
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the assignment.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
Result Syntax
[
'NextToken' => '<string>',
'PermissionSets' => ['<string>', ...],
]
Result Details
Members
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListPermissionSetsProvisionedToAccount
$result = $client->listPermissionSetsProvisionedToAccount([/* ... */]); $promise = $client->listPermissionSetsProvisionedToAccountAsync([/* ... */]);
Lists all the permission sets that are provisioned to a specified Amazon Web Services account.
Parameter Syntax
$result = $client->listPermissionSetsProvisionedToAccount([
'AccountId' => '<string>', // REQUIRED
'InstanceArn' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ProvisioningStatus' => 'LATEST_PERMISSION_SET_PROVISIONED|LATEST_PERMISSION_SET_NOT_PROVISIONED',
]);
Parameter Details
Members
- AccountId
-
- Required: Yes
- Type: string
The identifier of the Amazon Web Services account from which to list the assignments.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- MaxResults
-
- Type: int
The maximum number of results to display for the assignment.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
- ProvisioningStatus
-
- Type: string
The status object for the permission set provisioning operation.
Result Syntax
[
'NextToken' => '<string>',
'PermissionSets' => ['<string>', ...],
]
Result Details
Members
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags that are attached to a specified resource.
Parameter Syntax
$result = $client->listTagsForResource([
'InstanceArn' => '<string>', // REQUIRED
'NextToken' => '<string>',
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource with the tags to be listed.
Result Syntax
[
'NextToken' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
- Tags
-
- Type: Array of Tag structures
A set of key-value pairs that are used to manage the resource.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
ProvisionPermissionSet
$result = $client->provisionPermissionSet([/* ... */]); $promise = $client->provisionPermissionSetAsync([/* ... */]);
The process by which a specified permission set is provisioned to the specified target.
Parameter Syntax
$result = $client->provisionPermissionSet([
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
'TargetId' => '<string>',
'TargetType' => 'AWS_ACCOUNT|ALL_PROVISIONED_ACCOUNTS', // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set.
- TargetId
-
- Type: string
TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
- TargetType
-
- Required: Yes
- Type: string
The entity type for which the assignment will be created.
Result Syntax
[
'PermissionSetProvisioningStatus' => [
'AccountId' => '<string>',
'CreatedDate' => <DateTime>,
'FailureReason' => '<string>',
'PermissionSetArn' => '<string>',
'RequestId' => '<string>',
'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
],
]
Result Details
Members
- PermissionSetProvisioningStatus
-
- Type: PermissionSetProvisioningStatus structure
The status object for the permission set provisioning operation.
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
PutInlinePolicyToPermissionSet
$result = $client->putInlinePolicyToPermissionSet([/* ... */]); $promise = $client->putInlinePolicyToPermissionSetAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->putInlinePolicyToPermissionSet([
'InlinePolicy' => '<string>', // REQUIRED
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InlinePolicy
-
- Required: Yes
- Type: string
The IAM inline policy to attach to a PermissionSet.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
ServiceQuotaExceededException:
Indicates that the principal has crossed the permitted number of resources that can be created.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Associates a set of tags with a specified resource.
Parameter Syntax
$result = $client->tagResource([
'InstanceArn' => '<string>', // REQUIRED
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource with the tags to be listed.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
A set of key-value pairs that are used to manage the resource.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
ServiceQuotaExceededException:
Indicates that the principal has crossed the permitted number of resources that can be created.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Disassociates a set of tags from a specified resource.
Parameter Syntax
$result = $client->untagResource([
'InstanceArn' => '<string>', // REQUIRED
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- InstanceArn
-
- Required: Yes
- Type: string
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.
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource with the tags to be listed.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of tags that are attached to the resource.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
UpdateInstanceAccessControlAttributeConfiguration
$result = $client->updateInstanceAccessControlAttributeConfiguration([/* ... */]); $promise = $client->updateInstanceAccessControlAttributeConfigurationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateInstanceAccessControlAttributeConfiguration([
'InstanceAccessControlAttributeConfiguration' => [ // REQUIRED
'AccessControlAttributes' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => [ // REQUIRED
'Source' => ['<string>', ...], // REQUIRED
],
],
// ...
],
],
'InstanceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- InstanceAccessControlAttributeConfiguration
-
- Required: Yes
- Type: InstanceAccessControlAttributeConfiguration structure
Updates the attributes for your ABAC configuration.
- InstanceArn
-
- Required: Yes
- Type: string
The ARN of the SSO instance under which the operation will be executed.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
You do not have sufficient access to perform this action.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
Indicates that a requested resource is not found.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
UpdatePermissionSet
$result = $client->updatePermissionSet([/* ... */]); $promise = $client->updatePermissionSetAsync([/* ... */]);
Updates an existing permission set.
Parameter Syntax
$result = $client->updatePermissionSet([
'Description' => '<string>',
'InstanceArn' => '<string>', // REQUIRED
'PermissionSetArn' => '<string>', // REQUIRED
'RelayState' => '<string>',
'SessionDuration' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
The description of the PermissionSet.
- InstanceArn
-
- Required: Yes
- Type: string
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.
- PermissionSetArn
-
- Required: Yes
- Type: string
The ARN of the permission set.
- RelayState
-
- Type: string
Used to redirect users within the application during the federation authentication process.
- SessionDuration
-
- Type: string
The length of time that the application user sessions are valid for in the ISO-8601 standard.
Result Syntax
[]
Result Details
Errors
-
Indicates that a requested resource is not found.
-
The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
Indicates that the principal has crossed the throttling limits of the API operations.
-
The request failed because it contains a syntax error.
-
You do not have sufficient access to perform this action.
-
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
Shapes
AccessControlAttribute
Description
These are Amazon Web Services SSO identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your Amazon Web Services resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes, Amazon Web Services SSO passes the attribute values of the authenticated user into IAM for use in policy evaluation.
Members
- Key
-
- Required: Yes
- Type: string
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.
- Value
-
- Required: Yes
- Type: AccessControlAttributeValue structure
The value used for mapping a specified attribute to an identity source.
AccessControlAttributeValue
Description
The value used for mapping a specified attribute to an identity source.
Members
AccessDeniedException
AccountAssignment
Description
The assignment that indicates a principal's limited access to a specified Amazon Web Services account with a specified permission set.
The term principal here refers to a user or group that is defined in Amazon Web Services SSO.
Members
- AccountId
-
- Type: string
The identifier of the Amazon Web Services account.
- PermissionSetArn
-
- Type: string
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.
- PrincipalId
-
- Type: string
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.
- PrincipalType
-
- Type: string
The entity type for which the assignment will be created.
AccountAssignmentOperationStatus
Description
The status of the creation or deletion operation of an assignment that a principal needs to access an account.
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the permission set was created.
- FailureReason
-
- Type: string
The message that contains an error or exception in case of an operation failure.
- PermissionSetArn
-
- Type: string
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.
- PrincipalId
-
- Type: string
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.
- PrincipalType
-
- Type: string
The entity type for which the assignment will be created.
- RequestId
-
- Type: string
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
- Status
-
- Type: string
The status of the permission set provisioning process.
- TargetId
-
- Type: string
TargetID is an Amazon Web Services account identifier, typically a 10-12 digit string (For example, 123456789012).
- TargetType
-
- Type: string
The entity type for which the assignment will be created.
AccountAssignmentOperationStatusMetadata
Description
Provides information about the AccountAssignment creation request.
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the permission set was created.
- RequestId
-
- Type: string
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
- Status
-
- Type: string
The status of the permission set provisioning process.
AttachedManagedPolicy
Description
A structure that stores the details of the IAM managed policy.
Members
- Arn
-
- Type: string
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.
- Name
-
- Type: string
The name of the IAM managed policy.
ConflictException
Description
Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
Members
InstanceAccessControlAttributeConfiguration
Description
Specifies the attributes to add to your attribute-based access control (ABAC) configuration.
Members
- AccessControlAttributes
-
- Required: Yes
- Type: Array of AccessControlAttribute structures
Lists the attributes that are configured for ABAC in the specified Amazon Web Services SSO instance.
InstanceMetadata
Description
Provides information about the SSO instance.
Members
- IdentityStoreId
-
- Type: string
The identifier of the identity store that is connected to the SSO instance.
- InstanceArn
-
- Type: string
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.
InternalServerException
Description
The request processing has failed because of an unknown error, exception, or failure with an internal server.
Members
OperationStatusFilter
Description
Filters he operation status list based on the passed attribute value.
Members
PermissionSet
Description
An entity that contains IAM policies.
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the permission set was created.
- Description
-
- Type: string
The description of the PermissionSet.
- Name
-
- Type: string
The name of the permission set.
- PermissionSetArn
-
- Type: string
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.
- RelayState
-
- Type: string
Used to redirect users within the application during the federation authentication process.
- SessionDuration
-
- Type: string
The length of time that the application user sessions are valid for in the ISO-8601 standard.
PermissionSetProvisioningStatus
Description
A structure that is used to provide the status of the provisioning operation for a specified permission set.
Members
- AccountId
-
- Type: string
The identifier of the Amazon Web Services account from which to list the assignments.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the permission set was created.
- FailureReason
-
- Type: string
The message that contains an error or exception in case of an operation failure.
- PermissionSetArn
-
- Type: string
The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- RequestId
-
- Type: string
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
- Status
-
- Type: string
The status of the permission set provisioning process.
PermissionSetProvisioningStatusMetadata
Description
Provides information about the permission set provisioning status.
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the permission set was created.
- RequestId
-
- Type: string
The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
- Status
-
- Type: string
The status of the permission set provisioning process.
ResourceNotFoundException
ServiceQuotaExceededException
Description
Indicates that the principal has crossed the permitted number of resources that can be created.
Members
Tag
Description
A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that Amazon Web Services SSO creates in Amazon Web Services accounts.
Members
ThrottlingException
Description
Indicates that the principal has crossed the throttling limits of the API operations.