# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AddRegion](API_AddRegion.md) 
+  [AttachCustomerManagedPolicyReferenceToPermissionSet](API_AttachCustomerManagedPolicyReferenceToPermissionSet.md) 
+  [AttachManagedPolicyToPermissionSet](API_AttachManagedPolicyToPermissionSet.md) 
+  [CreateAccountAssignment](API_CreateAccountAssignment.md) 
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateApplicationAssignment](API_CreateApplicationAssignment.md) 
+  [CreateInstance](API_CreateInstance.md) 
+  [CreateInstanceAccessControlAttributeConfiguration](API_CreateInstanceAccessControlAttributeConfiguration.md) 
+  [CreatePermissionSet](API_CreatePermissionSet.md) 
+  [CreateTrustedTokenIssuer](API_CreateTrustedTokenIssuer.md) 
+  [DeleteAccountAssignment](API_DeleteAccountAssignment.md) 
+  [DeleteApplication](API_DeleteApplication.md) 
+  [DeleteApplicationAccessScope](API_DeleteApplicationAccessScope.md) 
+  [DeleteApplicationAssignment](API_DeleteApplicationAssignment.md) 
+  [DeleteApplicationAuthenticationMethod](API_DeleteApplicationAuthenticationMethod.md) 
+  [DeleteApplicationGrant](API_DeleteApplicationGrant.md) 
+  [DeleteInlinePolicyFromPermissionSet](API_DeleteInlinePolicyFromPermissionSet.md) 
+  [DeleteInstance](API_DeleteInstance.md) 
+  [DeleteInstanceAccessControlAttributeConfiguration](API_DeleteInstanceAccessControlAttributeConfiguration.md) 
+  [DeletePermissionsBoundaryFromPermissionSet](API_DeletePermissionsBoundaryFromPermissionSet.md) 
+  [DeletePermissionSet](API_DeletePermissionSet.md) 
+  [DeleteTrustedTokenIssuer](API_DeleteTrustedTokenIssuer.md) 
+  [DescribeAccountAssignmentCreationStatus](API_DescribeAccountAssignmentCreationStatus.md) 
+  [DescribeAccountAssignmentDeletionStatus](API_DescribeAccountAssignmentDeletionStatus.md) 
+  [DescribeApplication](API_DescribeApplication.md) 
+  [DescribeApplicationAssignment](API_DescribeApplicationAssignment.md) 
+  [DescribeApplicationProvider](API_DescribeApplicationProvider.md) 
+  [DescribeInstance](API_DescribeInstance.md) 
+  [DescribeInstanceAccessControlAttributeConfiguration](API_DescribeInstanceAccessControlAttributeConfiguration.md) 
+  [DescribePermissionSet](API_DescribePermissionSet.md) 
+  [DescribePermissionSetProvisioningStatus](API_DescribePermissionSetProvisioningStatus.md) 
+  [DescribeRegion](API_DescribeRegion.md) 
+  [DescribeTrustedTokenIssuer](API_DescribeTrustedTokenIssuer.md) 
+  [DetachCustomerManagedPolicyReferenceFromPermissionSet](API_DetachCustomerManagedPolicyReferenceFromPermissionSet.md) 
+  [DetachManagedPolicyFromPermissionSet](API_DetachManagedPolicyFromPermissionSet.md) 
+  [GetApplicationAccessScope](API_GetApplicationAccessScope.md) 
+  [GetApplicationAssignmentConfiguration](API_GetApplicationAssignmentConfiguration.md) 
+  [GetApplicationAuthenticationMethod](API_GetApplicationAuthenticationMethod.md) 
+  [GetApplicationGrant](API_GetApplicationGrant.md) 
+  [GetApplicationSessionConfiguration](API_GetApplicationSessionConfiguration.md) 
+  [GetInlinePolicyForPermissionSet](API_GetInlinePolicyForPermissionSet.md) 
+  [GetPermissionsBoundaryForPermissionSet](API_GetPermissionsBoundaryForPermissionSet.md) 
+  [ListAccountAssignmentCreationStatus](API_ListAccountAssignmentCreationStatus.md) 
+  [ListAccountAssignmentDeletionStatus](API_ListAccountAssignmentDeletionStatus.md) 
+  [ListAccountAssignments](API_ListAccountAssignments.md) 
+  [ListAccountAssignmentsForPrincipal](API_ListAccountAssignmentsForPrincipal.md) 
+  [ListAccountsForProvisionedPermissionSet](API_ListAccountsForProvisionedPermissionSet.md) 
+  [ListApplicationAccessScopes](API_ListApplicationAccessScopes.md) 
+  [ListApplicationAssignments](API_ListApplicationAssignments.md) 
+  [ListApplicationAssignmentsForPrincipal](API_ListApplicationAssignmentsForPrincipal.md) 
+  [ListApplicationAuthenticationMethods](API_ListApplicationAuthenticationMethods.md) 
+  [ListApplicationGrants](API_ListApplicationGrants.md) 
+  [ListApplicationProviders](API_ListApplicationProviders.md) 
+  [ListApplications](API_ListApplications.md) 
+  [ListCustomerManagedPolicyReferencesInPermissionSet](API_ListCustomerManagedPolicyReferencesInPermissionSet.md) 
+  [ListInstances](API_ListInstances.md) 
+  [ListManagedPoliciesInPermissionSet](API_ListManagedPoliciesInPermissionSet.md) 
+  [ListPermissionSetProvisioningStatus](API_ListPermissionSetProvisioningStatus.md) 
+  [ListPermissionSets](API_ListPermissionSets.md) 
+  [ListPermissionSetsProvisionedToAccount](API_ListPermissionSetsProvisionedToAccount.md) 
+  [ListRegions](API_ListRegions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTrustedTokenIssuers](API_ListTrustedTokenIssuers.md) 
+  [ProvisionPermissionSet](API_ProvisionPermissionSet.md) 
+  [PutApplicationAccessScope](API_PutApplicationAccessScope.md) 
+  [PutApplicationAssignmentConfiguration](API_PutApplicationAssignmentConfiguration.md) 
+  [PutApplicationAuthenticationMethod](API_PutApplicationAuthenticationMethod.md) 
+  [PutApplicationGrant](API_PutApplicationGrant.md) 
+  [PutApplicationSessionConfiguration](API_PutApplicationSessionConfiguration.md) 
+  [PutInlinePolicyToPermissionSet](API_PutInlinePolicyToPermissionSet.md) 
+  [PutPermissionsBoundaryToPermissionSet](API_PutPermissionsBoundaryToPermissionSet.md) 
+  [RemoveRegion](API_RemoveRegion.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateApplication](API_UpdateApplication.md) 
+  [UpdateInstance](API_UpdateInstance.md) 
+  [UpdateInstanceAccessControlAttributeConfiguration](API_UpdateInstanceAccessControlAttributeConfiguration.md) 
+  [UpdatePermissionSet](API_UpdatePermissionSet.md) 
+  [UpdateTrustedTokenIssuer](API_UpdateTrustedTokenIssuer.md) 

# AddRegion
<a name="API_AddRegion"></a>

Adds a Region to an IAM Identity Center instance. This operation initiates an asynchronous workflow to replicate the IAM Identity Center instance to the target Region. The Region status is set to ADDING at first and changes to ACTIVE when the workflow completes.

To use this operation, your IAM Identity Center instance and the target Region must meet the requirements described in the [IAM Identity Center User Guide](https://docs.aws.amazon.com/singlesignon/latest/userguide/multi-region-iam-identity-center.html#multi-region-prerequisites). 

The following actions are related to `AddRegion`:
+  [RemoveRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_RemoveRegion.html) 
+  [DescribeRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_DescribeRegion.html) 
+  [ListRegions](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListRegions.html) 

## Request Syntax
<a name="API_AddRegion_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "RegionName": "string"
}
```

## Request Parameters
<a name="API_AddRegion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_AddRegion_RequestSyntax) **   <a name="singlesignon-AddRegion-request-InstanceArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center instance to replicate to the target Region.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [RegionName](#API_AddRegion_RequestSyntax) **   <a name="singlesignon-AddRegion-request-RegionName"></a>
The name of the AWS Region to add to the IAM Identity Center instance. The Region name must be 1-32 characters long and follow the pattern of AWS Region names (for example, us-east-1).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `([a-z]+-){2,3}\d`   
Required: Yes

## Response Syntax
<a name="API_AddRegion_ResponseSyntax"></a>

```
{
   "Status": "string"
}
```

## Response Elements
<a name="API_AddRegion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Status](#API_AddRegion_ResponseSyntax) **   <a name="singlesignon-AddRegion-response-Status"></a>
The status of the Region after the Add operation. The status is ADDING when the asynchronous workflow is in progress and changes to ACTIVE when complete.  
Type: String  
Valid Values: `ACTIVE | ADDING | REMOVING` 

## Errors
<a name="API_AddRegion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_AddRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/AddRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/AddRegion) 

# AttachCustomerManagedPolicyReferenceToPermissionSet
<a name="API_AttachCustomerManagedPolicyReferenceToPermissionSet"></a>

Attaches the specified customer managed policy to the specified [PermissionSet](API_PermissionSet.md).

## Request Syntax
<a name="API_AttachCustomerManagedPolicyReferenceToPermissionSet_RequestSyntax"></a>

```
{
   "CustomerManagedPolicyReference": { 
      "Name": "string",
      "Path": "string"
   },
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_AttachCustomerManagedPolicyReferenceToPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CustomerManagedPolicyReference](#API_AttachCustomerManagedPolicyReferenceToPermissionSet_RequestSyntax) **   <a name="singlesignon-AttachCustomerManagedPolicyReferenceToPermissionSet-request-CustomerManagedPolicyReference"></a>
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.  
Type: [CustomerManagedPolicyReference](API_CustomerManagedPolicyReference.md) object  
Required: Yes

 ** [InstanceArn](#API_AttachCustomerManagedPolicyReferenceToPermissionSet_RequestSyntax) **   <a name="singlesignon-AttachCustomerManagedPolicyReferenceToPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_AttachCustomerManagedPolicyReferenceToPermissionSet_RequestSyntax) **   <a name="singlesignon-AttachCustomerManagedPolicyReferenceToPermissionSet-request-PermissionSetArn"></a>
The ARN of the `PermissionSet`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_AttachCustomerManagedPolicyReferenceToPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AttachCustomerManagedPolicyReferenceToPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_AttachCustomerManagedPolicyReferenceToPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/AttachCustomerManagedPolicyReferenceToPermissionSet) 

# AttachManagedPolicyToPermissionSet
<a name="API_AttachManagedPolicyToPermissionSet"></a>

Attaches an AWS managed policy ARN to a permission set.

**Note**  
If the permission set is already referenced by one or more account assignments, you will need to call ` ProvisionPermissionSet ` after this operation. Calling `ProvisionPermissionSet` applies the corresponding IAM policy updates to all assigned accounts.

## Request Syntax
<a name="API_AttachManagedPolicyToPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "ManagedPolicyArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_AttachManagedPolicyToPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_AttachManagedPolicyToPermissionSet_RequestSyntax) **   <a name="singlesignon-AttachManagedPolicyToPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [ManagedPolicyArn](#API_AttachManagedPolicyToPermissionSet_RequestSyntax) **   <a name="singlesignon-AttachManagedPolicyToPermissionSet-request-ManagedPolicyArn"></a>
The AWS managed policy ARN to be attached to a permission set.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:iam::aws:policy((/[A-Za-z0-9\.,\+@=_-]+)*)/([A-Za-z0-9\.,\+=@_-]+)`   
Required: Yes

 ** [PermissionSetArn](#API_AttachManagedPolicyToPermissionSet_RequestSyntax) **   <a name="singlesignon-AttachManagedPolicyToPermissionSet-request-PermissionSetArn"></a>
The ARN of the [PermissionSet](API_PermissionSet.md) that the managed policy should be attached to.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_AttachManagedPolicyToPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AttachManagedPolicyToPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_AttachManagedPolicyToPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/AttachManagedPolicyToPermissionSet) 

# CreateAccountAssignment
<a name="API_CreateAccountAssignment"></a>

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

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

**Note**  
As part of a successful `CreateAccountAssignment` call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call ` ProvisionPermissionSet ` to make these updates.

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

## Request Syntax
<a name="API_CreateAccountAssignment_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string",
   "PrincipalId": "string",
   "PrincipalType": "string",
   "TargetId": "string",
   "TargetType": "string"
}
```

## Request Parameters
<a name="API_CreateAccountAssignment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_CreateAccountAssignment_RequestSyntax) **   <a name="singlesignon-CreateAccountAssignment-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_CreateAccountAssignment_RequestSyntax) **   <a name="singlesignon-CreateAccountAssignment-request-PermissionSetArn"></a>
The ARN of the permission set that the admin wants to grant the principal access to.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

 ** [PrincipalId](#API_CreateAccountAssignment_RequestSyntax) **   <a name="singlesignon-CreateAccountAssignment-request-PrincipalId"></a>
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [PrincipalType](#API_CreateAccountAssignment_RequestSyntax) **   <a name="singlesignon-CreateAccountAssignment-request-PrincipalType"></a>
The entity type for which the assignment will be created.  
Type: String  
Valid Values: `USER | GROUP`   
Required: Yes

 ** [TargetId](#API_CreateAccountAssignment_RequestSyntax) **   <a name="singlesignon-CreateAccountAssignment-request-TargetId"></a>
TargetID is an AWS account identifier, (For example, 123456789012).  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: Yes

 ** [TargetType](#API_CreateAccountAssignment_RequestSyntax) **   <a name="singlesignon-CreateAccountAssignment-request-TargetType"></a>
The entity type for which the assignment will be created.  
Type: String  
Valid Values: `AWS_ACCOUNT`   
Required: Yes

## Response Syntax
<a name="API_CreateAccountAssignment_ResponseSyntax"></a>

```
{
   "AccountAssignmentCreationStatus": { 
      "CreatedDate": number,
      "FailureReason": "string",
      "PermissionSetArn": "string",
      "PrincipalId": "string",
      "PrincipalType": "string",
      "RequestId": "string",
      "Status": "string",
      "TargetId": "string",
      "TargetType": "string"
   }
}
```

## Response Elements
<a name="API_CreateAccountAssignment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignmentCreationStatus](#API_CreateAccountAssignment_ResponseSyntax) **   <a name="singlesignon-CreateAccountAssignment-response-AccountAssignmentCreationStatus"></a>
The status object for the account assignment creation operation.  
Type: [AccountAssignmentOperationStatus](API_AccountAssignmentOperationStatus.md) object

## Errors
<a name="API_CreateAccountAssignment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateAccountAssignment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/CreateAccountAssignment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/CreateAccountAssignment) 

# CreateApplication
<a name="API_CreateApplication"></a>

Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.

**Note**  
This API does not support creating SAML 2.0 customer managed applications or AWS managed applications. To learn how to create an AWS managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the AWS Management Console only. See [Setting up customer managed SAML 2.0 applications](https://docs.aws.amazon.com/singlesignon/latest/userguide/customermanagedapps-saml2-setup.html). For more information on these application types, see [AWS managed applications](https://docs.aws.amazon.com/singlesignon/latest/userguide/awsapps.html).

## Request Syntax
<a name="API_CreateApplication_RequestSyntax"></a>

```
{
   "ApplicationProviderArn": "string",
   "ClientToken": "string",
   "Description": "string",
   "InstanceArn": "string",
   "Name": "string",
   "PortalOptions": { 
      "SignInOptions": { 
         "ApplicationUrl": "string",
         "Origin": "string"
      },
      "Visibility": "string"
   },
   "Status": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationProviderArn](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-ApplicationProviderArn"></a>
The ARN of the application provider under which the operation will run.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::aws:applicationProvider/[a-zA-Z0-9-/]+`   
Required: Yes

 ** [ClientToken](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-ClientToken"></a>
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a [UUID type of value](https://wikipedia.org/wiki/Universally_unique_identifier).  
If you don't provide this value, then AWS generates a random one for you.  
If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]+`   
Required: No

 ** [Description](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-Description"></a>
The description of the [Application](API_Application.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [InstanceArn](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-InstanceArn"></a>
The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [Name](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-Name"></a>
The name of the [Application](API_Application.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\S\s]*`   
Required: Yes

 ** [PortalOptions](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-PortalOptions"></a>
A structure that describes the options for the portal associated with an application.  
Type: [PortalOptions](API_PortalOptions.md) object  
Required: No

 ** [Status](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-Status"></a>
Specifies whether the application is enabled or disabled.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [Tags](#API_CreateApplication_RequestSyntax) **   <a name="singlesignon-CreateApplication-request-Tags"></a>
Specifies tags to be attached to the application.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 75 items.  
Required: No

## Response Syntax
<a name="API_CreateApplication_ResponseSyntax"></a>

```
{
   "ApplicationArn": "string"
}
```

## Response Elements
<a name="API_CreateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationArn](#API_CreateApplication_ResponseSyntax) **   <a name="singlesignon-CreateApplication-response-ApplicationArn"></a>
Specifies the ARN of the application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}` 

## Errors
<a name="API_CreateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/CreateApplication) 

# CreateApplicationAssignment
<a name="API_CreateApplicationAssignment"></a>

Grant application access to a user or group.

## Request Syntax
<a name="API_CreateApplicationAssignment_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "PrincipalId": "string",
   "PrincipalType": "string"
}
```

## Request Parameters
<a name="API_CreateApplicationAssignment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_CreateApplicationAssignment_RequestSyntax) **   <a name="singlesignon-CreateApplicationAssignment-request-ApplicationArn"></a>
The ARN of the application for which the assignment is created.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [PrincipalId](#API_CreateApplicationAssignment_RequestSyntax) **   <a name="singlesignon-CreateApplicationAssignment-request-PrincipalId"></a>
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [PrincipalType](#API_CreateApplicationAssignment_RequestSyntax) **   <a name="singlesignon-CreateApplicationAssignment-request-PrincipalType"></a>
The entity type for which the assignment will be created.  
Type: String  
Valid Values: `USER | GROUP`   
Required: Yes

## Response Elements
<a name="API_CreateApplicationAssignment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CreateApplicationAssignment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateApplicationAssignment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/CreateApplicationAssignment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/CreateApplicationAssignment) 

# CreateInstance
<a name="API_CreateInstance"></a>

Creates an instance of IAM Identity Center for a standalone AWS account that is not managed by AWS Organizations or a member AWS account in an organization. You can create only one instance per account and across all AWS Regions.

The CreateInstance request is rejected if the following apply: 
+ The instance is created within the organization management account.
+ An instance already exists in the same account.

## Request Syntax
<a name="API_CreateInstance_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateInstance_RequestSyntax) **   <a name="singlesignon-CreateInstance-request-ClientToken"></a>
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a [UUID type of value](https://wikipedia.org/wiki/Universally_unique_identifier).  
If you don't provide this value, then AWS generates a random one for you.  
If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]+`   
Required: No

 ** [Name](#API_CreateInstance_RequestSyntax) **   <a name="singlesignon-CreateInstance-request-Name"></a>
The name of the instance of IAM Identity Center.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\w+=,.@-]+`   
Required: No

 ** [Tags](#API_CreateInstance_RequestSyntax) **   <a name="singlesignon-CreateInstance-request-Tags"></a>
Specifies tags to be attached to the instance of IAM Identity Center.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 75 items.  
Required: No

## Response Syntax
<a name="API_CreateInstance_ResponseSyntax"></a>

```
{
   "InstanceArn": "string"
}
```

## Response Elements
<a name="API_CreateInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceArn](#API_CreateInstance_ResponseSyntax) **   <a name="singlesignon-CreateInstance-response-InstanceArn"></a>
The ARN of the instance of IAM Identity Center under which the operation will run.   
For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}` 

## Errors
<a name="API_CreateInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/CreateInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/CreateInstance) 

# CreateInstanceAccessControlAttributeConfiguration
<a name="API_CreateInstanceAccessControlAttributeConfiguration"></a>

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see [Attribute-Based Access Control](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center User Guide*.

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

## Request Syntax
<a name="API_CreateInstanceAccessControlAttributeConfiguration_RequestSyntax"></a>

```
{
   "InstanceAccessControlAttributeConfiguration": { 
      "AccessControlAttributes": [ 
         { 
            "Key": "string",
            "Value": { 
               "Source": [ "string" ]
            }
         }
      ]
   },
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_CreateInstanceAccessControlAttributeConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceAccessControlAttributeConfiguration](#API_CreateInstanceAccessControlAttributeConfiguration_RequestSyntax) **   <a name="singlesignon-CreateInstanceAccessControlAttributeConfiguration-request-InstanceAccessControlAttributeConfiguration"></a>
Specifies the IAM Identity Center 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 IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.  
Type: [InstanceAccessControlAttributeConfiguration](API_InstanceAccessControlAttributeConfiguration.md) object  
Required: Yes

 ** [InstanceArn](#API_CreateInstanceAccessControlAttributeConfiguration_RequestSyntax) **   <a name="singlesignon-CreateInstanceAccessControlAttributeConfiguration-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Elements
<a name="API_CreateInstanceAccessControlAttributeConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CreateInstanceAccessControlAttributeConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateInstanceAccessControlAttributeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/CreateInstanceAccessControlAttributeConfiguration) 

# CreatePermissionSet
<a name="API_CreatePermissionSet"></a>

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

**Note**  
To grant users and groups access to AWS account resources, use ` CreateAccountAssignment `.

## Request Syntax
<a name="API_CreatePermissionSet_RequestSyntax"></a>

```
{
   "Description": "string",
   "InstanceArn": "string",
   "Name": "string",
   "RelayState": "string",
   "SessionDuration": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreatePermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_CreatePermissionSet_RequestSyntax) **   <a name="singlesignon-CreatePermissionSet-request-Description"></a>
The description of the [PermissionSet](API_PermissionSet.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 700.  
Pattern: `[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]*`   
Required: No

 ** [InstanceArn](#API_CreatePermissionSet_RequestSyntax) **   <a name="singlesignon-CreatePermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [Name](#API_CreatePermissionSet_RequestSyntax) **   <a name="singlesignon-CreatePermissionSet-request-Name"></a>
The name of the [PermissionSet](API_PermissionSet.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `[\w+=,.@-]+`   
Required: Yes

 ** [RelayState](#API_CreatePermissionSet_RequestSyntax) **   <a name="singlesignon-CreatePermissionSet-request-RelayState"></a>
Used to redirect users within the application during the federation authentication process.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Pattern: `[a-zA-Z0-9&$@#\\\/%?=~\-_'"|!:,.;*+\[\]\ \(\)\{\}]+`   
Required: No

 ** [SessionDuration](#API_CreatePermissionSet_RequestSyntax) **   <a name="singlesignon-CreatePermissionSet-request-SessionDuration"></a>
The length of time that the application user sessions are valid in the ISO-8601 standard.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?`   
Required: No

 ** [Tags](#API_CreatePermissionSet_RequestSyntax) **   <a name="singlesignon-CreatePermissionSet-request-Tags"></a>
The tags to attach to the new [PermissionSet](API_PermissionSet.md).  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 75 items.  
Required: No

## Response Syntax
<a name="API_CreatePermissionSet_ResponseSyntax"></a>

```
{
   "PermissionSet": { 
      "CreatedDate": number,
      "Description": "string",
      "Name": "string",
      "PermissionSetArn": "string",
      "RelayState": "string",
      "SessionDuration": "string"
   }
}
```

## Response Elements
<a name="API_CreatePermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PermissionSet](#API_CreatePermissionSet_ResponseSyntax) **   <a name="singlesignon-CreatePermissionSet-response-PermissionSet"></a>
Defines the level of access on an AWS account.  
Type: [PermissionSet](API_PermissionSet.md) object

## Errors
<a name="API_CreatePermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_CreatePermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/CreatePermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/CreatePermissionSet) 

# CreateTrustedTokenIssuer
<a name="API_CreateTrustedTokenIssuer"></a>

Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of AWS.

This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication. 

## Request Syntax
<a name="API_CreateTrustedTokenIssuer_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "InstanceArn": "string",
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrustedTokenIssuerConfiguration": { ... },
   "TrustedTokenIssuerType": "string"
}
```

## Request Parameters
<a name="API_CreateTrustedTokenIssuer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-CreateTrustedTokenIssuer-request-ClientToken"></a>
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a [UUID type of value.](https://wikipedia.org/wiki/Universally_unique_identifier).  
If you don't provide this value, then AWS generates a random one for you.  
If you retry the operation with the same `ClientToken`, but with different parameters, the retry fails with an `IdempotentParameterMismatch` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]+`   
Required: No

 ** [InstanceArn](#API_CreateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-CreateTrustedTokenIssuer-request-InstanceArn"></a>
Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [Name](#API_CreateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-CreateTrustedTokenIssuer-request-Name"></a>
Specifies the name of the new trusted token issuer configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\w+=,.@-]+`   
Required: Yes

 ** [Tags](#API_CreateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-CreateTrustedTokenIssuer-request-Tags"></a>
Specifies tags to be attached to the new trusted token issuer configuration.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 75 items.  
Required: No

 ** [TrustedTokenIssuerConfiguration](#API_CreateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-CreateTrustedTokenIssuer-request-TrustedTokenIssuerConfiguration"></a>
Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what `TrustedTokenIssuerType` you specify.  
Type: [TrustedTokenIssuerConfiguration](API_TrustedTokenIssuerConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [TrustedTokenIssuerType](#API_CreateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-CreateTrustedTokenIssuer-request-TrustedTokenIssuerType"></a>
Specifies the type of the new trusted token issuer.  
Type: String  
Valid Values: `OIDC_JWT`   
Required: Yes

## Response Syntax
<a name="API_CreateTrustedTokenIssuer_ResponseSyntax"></a>

```
{
   "TrustedTokenIssuerArn": "string"
}
```

## Response Elements
<a name="API_CreateTrustedTokenIssuer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TrustedTokenIssuerArn](#API_CreateTrustedTokenIssuer_ResponseSyntax) **   <a name="singlesignon-CreateTrustedTokenIssuer-response-TrustedTokenIssuerArn"></a>
The ARN of the new trusted token issuer configuration.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_CreateTrustedTokenIssuer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateTrustedTokenIssuer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/CreateTrustedTokenIssuer) 

# DeleteAccountAssignment
<a name="API_DeleteAccountAssignment"></a>

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

**Note**  
After a successful response, call `DescribeAccountAssignmentDeletionStatus` to describe the status of an assignment deletion request.

## Request Syntax
<a name="API_DeleteAccountAssignment_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string",
   "PrincipalId": "string",
   "PrincipalType": "string",
   "TargetId": "string",
   "TargetType": "string"
}
```

## Request Parameters
<a name="API_DeleteAccountAssignment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DeleteAccountAssignment_RequestSyntax) **   <a name="singlesignon-DeleteAccountAssignment-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_DeleteAccountAssignment_RequestSyntax) **   <a name="singlesignon-DeleteAccountAssignment-request-PermissionSetArn"></a>
The ARN of the permission set that will be used to remove access.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

 ** [PrincipalId](#API_DeleteAccountAssignment_RequestSyntax) **   <a name="singlesignon-DeleteAccountAssignment-request-PrincipalId"></a>
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [PrincipalType](#API_DeleteAccountAssignment_RequestSyntax) **   <a name="singlesignon-DeleteAccountAssignment-request-PrincipalType"></a>
The entity type for which the assignment will be deleted.  
Type: String  
Valid Values: `USER | GROUP`   
Required: Yes

 ** [TargetId](#API_DeleteAccountAssignment_RequestSyntax) **   <a name="singlesignon-DeleteAccountAssignment-request-TargetId"></a>
TargetID is an AWS account identifier, (For example, 123456789012).  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: Yes

 ** [TargetType](#API_DeleteAccountAssignment_RequestSyntax) **   <a name="singlesignon-DeleteAccountAssignment-request-TargetType"></a>
The entity type for which the assignment will be deleted.  
Type: String  
Valid Values: `AWS_ACCOUNT`   
Required: Yes

## Response Syntax
<a name="API_DeleteAccountAssignment_ResponseSyntax"></a>

```
{
   "AccountAssignmentDeletionStatus": { 
      "CreatedDate": number,
      "FailureReason": "string",
      "PermissionSetArn": "string",
      "PrincipalId": "string",
      "PrincipalType": "string",
      "RequestId": "string",
      "Status": "string",
      "TargetId": "string",
      "TargetType": "string"
   }
}
```

## Response Elements
<a name="API_DeleteAccountAssignment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignmentDeletionStatus](#API_DeleteAccountAssignment_ResponseSyntax) **   <a name="singlesignon-DeleteAccountAssignment-response-AccountAssignmentDeletionStatus"></a>
The status object for the account assignment deletion operation.  
Type: [AccountAssignmentOperationStatus](API_AccountAssignmentOperationStatus.md) object

## Errors
<a name="API_DeleteAccountAssignment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteAccountAssignment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteAccountAssignment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteAccountAssignment) 

# DeleteApplication
<a name="API_DeleteApplication"></a>

Deletes the association with the application. The connected service resource still exists.

## Request Syntax
<a name="API_DeleteApplication_RequestSyntax"></a>

```
{
   "ApplicationArn": "string"
}
```

## Request Parameters
<a name="API_DeleteApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_DeleteApplication_RequestSyntax) **   <a name="singlesignon-DeleteApplication-request-ApplicationArn"></a>
Specifies the ARN of the application. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

## Response Elements
<a name="API_DeleteApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteApplication) 

# DeleteApplicationAccessScope
<a name="API_DeleteApplicationAccessScope"></a>

Deletes an IAM Identity Center access scope from an application.

## Request Syntax
<a name="API_DeleteApplicationAccessScope_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "Scope": "string"
}
```

## Request Parameters
<a name="API_DeleteApplicationAccessScope_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_DeleteApplicationAccessScope_RequestSyntax) **   <a name="singlesignon-DeleteApplicationAccessScope-request-ApplicationArn"></a>
Specifies the ARN of the application with the access scope to delete.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [Scope](#API_DeleteApplicationAccessScope_RequestSyntax) **   <a name="singlesignon-DeleteApplicationAccessScope-request-Scope"></a>
Specifies the name of the access scope to remove from the application.  
Type: String  
Pattern: `([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}`   
Required: Yes

## Response Elements
<a name="API_DeleteApplicationAccessScope_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationAccessScope_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteApplicationAccessScope_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteApplicationAccessScope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteApplicationAccessScope) 

# DeleteApplicationAssignment
<a name="API_DeleteApplicationAssignment"></a>

Revoke application access to an application by deleting application assignments for a user or group.

## Request Syntax
<a name="API_DeleteApplicationAssignment_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "PrincipalId": "string",
   "PrincipalType": "string"
}
```

## Request Parameters
<a name="API_DeleteApplicationAssignment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_DeleteApplicationAssignment_RequestSyntax) **   <a name="singlesignon-DeleteApplicationAssignment-request-ApplicationArn"></a>
Specifies the ARN of the application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [PrincipalId](#API_DeleteApplicationAssignment_RequestSyntax) **   <a name="singlesignon-DeleteApplicationAssignment-request-PrincipalId"></a>
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [PrincipalType](#API_DeleteApplicationAssignment_RequestSyntax) **   <a name="singlesignon-DeleteApplicationAssignment-request-PrincipalType"></a>
The entity type for which the assignment will be deleted.  
Type: String  
Valid Values: `USER | GROUP`   
Required: Yes

## Response Elements
<a name="API_DeleteApplicationAssignment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationAssignment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteApplicationAssignment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteApplicationAssignment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteApplicationAssignment) 

# DeleteApplicationAuthenticationMethod
<a name="API_DeleteApplicationAuthenticationMethod"></a>

Deletes an authentication method from an application.

## Request Syntax
<a name="API_DeleteApplicationAuthenticationMethod_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "AuthenticationMethodType": "string"
}
```

## Request Parameters
<a name="API_DeleteApplicationAuthenticationMethod_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_DeleteApplicationAuthenticationMethod_RequestSyntax) **   <a name="singlesignon-DeleteApplicationAuthenticationMethod-request-ApplicationArn"></a>
Specifies the ARN of the application with the authentication method to delete.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [AuthenticationMethodType](#API_DeleteApplicationAuthenticationMethod_RequestSyntax) **   <a name="singlesignon-DeleteApplicationAuthenticationMethod-request-AuthenticationMethodType"></a>
Specifies the authentication method type to delete from the application.  
Type: String  
Valid Values: `IAM`   
Required: Yes

## Response Elements
<a name="API_DeleteApplicationAuthenticationMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationAuthenticationMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteApplicationAuthenticationMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteApplicationAuthenticationMethod) 

# DeleteApplicationGrant
<a name="API_DeleteApplicationGrant"></a>

Deletes a grant from an application.

## Request Syntax
<a name="API_DeleteApplicationGrant_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "GrantType": "string"
}
```

## Request Parameters
<a name="API_DeleteApplicationGrant_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_DeleteApplicationGrant_RequestSyntax) **   <a name="singlesignon-DeleteApplicationGrant-request-ApplicationArn"></a>
Specifies the ARN of the application with the grant to delete.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [GrantType](#API_DeleteApplicationGrant_RequestSyntax) **   <a name="singlesignon-DeleteApplicationGrant-request-GrantType"></a>
Specifies the type of grant to delete from the application.  
Type: String  
Valid Values: `authorization_code | refresh_token | urn:ietf:params:oauth:grant-type:jwt-bearer | urn:ietf:params:oauth:grant-type:token-exchange`   
Required: Yes

## Response Elements
<a name="API_DeleteApplicationGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplicationGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteApplicationGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteApplicationGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteApplicationGrant) 

# DeleteInlinePolicyFromPermissionSet
<a name="API_DeleteInlinePolicyFromPermissionSet"></a>

Deletes the inline policy from a specified permission set.

## Request Syntax
<a name="API_DeleteInlinePolicyFromPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_DeleteInlinePolicyFromPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DeleteInlinePolicyFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DeleteInlinePolicyFromPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_DeleteInlinePolicyFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DeleteInlinePolicyFromPermissionSet-request-PermissionSetArn"></a>
The ARN of the permission set that will be used to remove access.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_DeleteInlinePolicyFromPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteInlinePolicyFromPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteInlinePolicyFromPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteInlinePolicyFromPermissionSet) 

# DeleteInstance
<a name="API_DeleteInstance"></a>

Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.

## Request Syntax
<a name="API_DeleteInstance_RequestSyntax"></a>

```
{
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_DeleteInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DeleteInstance_RequestSyntax) **   <a name="singlesignon-DeleteInstance-request-InstanceArn"></a>
The ARN of the instance of IAM Identity Center under which the operation will run.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Elements
<a name="API_DeleteInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteInstance) 

# DeleteInstanceAccessControlAttributeConfiguration
<a name="API_DeleteInstanceAccessControlAttributeConfiguration"></a>

Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see [Attribute-Based Access Control](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center User Guide*.

## Request Syntax
<a name="API_DeleteInstanceAccessControlAttributeConfiguration_RequestSyntax"></a>

```
{
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_DeleteInstanceAccessControlAttributeConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DeleteInstanceAccessControlAttributeConfiguration_RequestSyntax) **   <a name="singlesignon-DeleteInstanceAccessControlAttributeConfiguration-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Elements
<a name="API_DeleteInstanceAccessControlAttributeConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteInstanceAccessControlAttributeConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteInstanceAccessControlAttributeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteInstanceAccessControlAttributeConfiguration) 

# DeletePermissionsBoundaryFromPermissionSet
<a name="API_DeletePermissionsBoundaryFromPermissionSet"></a>

Deletes the permissions boundary from a specified [PermissionSet](API_PermissionSet.md).

## Request Syntax
<a name="API_DeletePermissionsBoundaryFromPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_DeletePermissionsBoundaryFromPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DeletePermissionsBoundaryFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DeletePermissionsBoundaryFromPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_DeletePermissionsBoundaryFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DeletePermissionsBoundaryFromPermissionSet-request-PermissionSetArn"></a>
The ARN of the `PermissionSet`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_DeletePermissionsBoundaryFromPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePermissionsBoundaryFromPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeletePermissionsBoundaryFromPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeletePermissionsBoundaryFromPermissionSet) 

# DeletePermissionSet
<a name="API_DeletePermissionSet"></a>

Deletes the specified permission set.

## Request Syntax
<a name="API_DeletePermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_DeletePermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DeletePermissionSet_RequestSyntax) **   <a name="singlesignon-DeletePermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_DeletePermissionSet_RequestSyntax) **   <a name="singlesignon-DeletePermissionSet-request-PermissionSetArn"></a>
The ARN of the permission set that should be deleted.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_DeletePermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeletePermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeletePermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeletePermissionSet) 

# DeleteTrustedTokenIssuer
<a name="API_DeleteTrustedTokenIssuer"></a>

Deletes a trusted token issuer configuration from an instance of IAM Identity Center.

**Note**  
Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.

## Request Syntax
<a name="API_DeleteTrustedTokenIssuer_RequestSyntax"></a>

```
{
   "TrustedTokenIssuerArn": "string"
}
```

## Request Parameters
<a name="API_DeleteTrustedTokenIssuer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TrustedTokenIssuerArn](#API_DeleteTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-DeleteTrustedTokenIssuer-request-TrustedTokenIssuerArn"></a>
Specifies the ARN of the trusted token issuer configuration to delete.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Response Elements
<a name="API_DeleteTrustedTokenIssuer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTrustedTokenIssuer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteTrustedTokenIssuer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DeleteTrustedTokenIssuer) 

# DescribeAccountAssignmentCreationStatus
<a name="API_DescribeAccountAssignmentCreationStatus"></a>

Describes the status of the assignment creation request.

## Request Syntax
<a name="API_DescribeAccountAssignmentCreationStatus_RequestSyntax"></a>

```
{
   "AccountAssignmentCreationRequestId": "string",
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_DescribeAccountAssignmentCreationStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccountAssignmentCreationRequestId](#API_DescribeAccountAssignmentCreationStatus_RequestSyntax) **   <a name="singlesignon-DescribeAccountAssignmentCreationStatus-request-AccountAssignmentCreationRequestId"></a>
The identifier that is used to track the request operation progress.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b`   
Required: Yes

 ** [InstanceArn](#API_DescribeAccountAssignmentCreationStatus_RequestSyntax) **   <a name="singlesignon-DescribeAccountAssignmentCreationStatus-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Syntax
<a name="API_DescribeAccountAssignmentCreationStatus_ResponseSyntax"></a>

```
{
   "AccountAssignmentCreationStatus": { 
      "CreatedDate": number,
      "FailureReason": "string",
      "PermissionSetArn": "string",
      "PrincipalId": "string",
      "PrincipalType": "string",
      "RequestId": "string",
      "Status": "string",
      "TargetId": "string",
      "TargetType": "string"
   }
}
```

## Response Elements
<a name="API_DescribeAccountAssignmentCreationStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignmentCreationStatus](#API_DescribeAccountAssignmentCreationStatus_ResponseSyntax) **   <a name="singlesignon-DescribeAccountAssignmentCreationStatus-response-AccountAssignmentCreationStatus"></a>
The status object for the account assignment creation operation.  
Type: [AccountAssignmentOperationStatus](API_AccountAssignmentOperationStatus.md) object

## Errors
<a name="API_DescribeAccountAssignmentCreationStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeAccountAssignmentCreationStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeAccountAssignmentCreationStatus) 

# DescribeAccountAssignmentDeletionStatus
<a name="API_DescribeAccountAssignmentDeletionStatus"></a>

Describes the status of the assignment deletion request.

## Request Syntax
<a name="API_DescribeAccountAssignmentDeletionStatus_RequestSyntax"></a>

```
{
   "AccountAssignmentDeletionRequestId": "string",
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_DescribeAccountAssignmentDeletionStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccountAssignmentDeletionRequestId](#API_DescribeAccountAssignmentDeletionStatus_RequestSyntax) **   <a name="singlesignon-DescribeAccountAssignmentDeletionStatus-request-AccountAssignmentDeletionRequestId"></a>
The identifier that is used to track the request operation progress.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b`   
Required: Yes

 ** [InstanceArn](#API_DescribeAccountAssignmentDeletionStatus_RequestSyntax) **   <a name="singlesignon-DescribeAccountAssignmentDeletionStatus-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Syntax
<a name="API_DescribeAccountAssignmentDeletionStatus_ResponseSyntax"></a>

```
{
   "AccountAssignmentDeletionStatus": { 
      "CreatedDate": number,
      "FailureReason": "string",
      "PermissionSetArn": "string",
      "PrincipalId": "string",
      "PrincipalType": "string",
      "RequestId": "string",
      "Status": "string",
      "TargetId": "string",
      "TargetType": "string"
   }
}
```

## Response Elements
<a name="API_DescribeAccountAssignmentDeletionStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignmentDeletionStatus](#API_DescribeAccountAssignmentDeletionStatus_ResponseSyntax) **   <a name="singlesignon-DescribeAccountAssignmentDeletionStatus-response-AccountAssignmentDeletionStatus"></a>
The status object for the account assignment deletion operation.  
Type: [AccountAssignmentOperationStatus](API_AccountAssignmentOperationStatus.md) object

## Errors
<a name="API_DescribeAccountAssignmentDeletionStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeAccountAssignmentDeletionStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeAccountAssignmentDeletionStatus) 

# DescribeApplication
<a name="API_DescribeApplication"></a>

Retrieves the details of an application associated with an instance of IAM Identity Center.

## Request Syntax
<a name="API_DescribeApplication_RequestSyntax"></a>

```
{
   "ApplicationArn": "string"
}
```

## Request Parameters
<a name="API_DescribeApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_DescribeApplication_RequestSyntax) **   <a name="singlesignon-DescribeApplication-request-ApplicationArn"></a>
Specifies the ARN of the application. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

## Response Syntax
<a name="API_DescribeApplication_ResponseSyntax"></a>

```
{
   "ApplicationAccount": "string",
   "ApplicationArn": "string",
   "ApplicationProviderArn": "string",
   "CreatedDate": number,
   "CreatedFrom": "string",
   "Description": "string",
   "InstanceArn": "string",
   "Name": "string",
   "PortalOptions": { 
      "SignInOptions": { 
         "ApplicationUrl": "string",
         "Origin": "string"
      },
      "Visibility": "string"
   },
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribeApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationAccount](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-ApplicationAccount"></a>
The account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [ApplicationArn](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-ApplicationArn"></a>
Specifies the ARN of the application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}` 

 ** [ApplicationProviderArn](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-ApplicationProviderArn"></a>
The ARN of the application provider under which the operation will run.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::aws:applicationProvider/[a-zA-Z0-9-/]+` 

 ** [CreatedDate](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-CreatedDate"></a>
The date the application was created.  
Type: Timestamp

 ** [CreatedFrom](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-CreatedFrom"></a>
The AWS Region where the application was created in IAM Identity Center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `([a-z]+-){2,3}\d` 

 ** [Description](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-Description"></a>
The description of the [Application](API_Application.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [InstanceArn](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-InstanceArn"></a>
The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}` 

 ** [Name](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-Name"></a>
The application name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\S\s]*` 

 ** [PortalOptions](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-PortalOptions"></a>
A structure that describes the options for the portal associated with an application.  
Type: [PortalOptions](API_PortalOptions.md) object

 ** [Status](#API_DescribeApplication_ResponseSyntax) **   <a name="singlesignon-DescribeApplication-response-Status"></a>
Specifies whether the application is enabled or disabled.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

## Errors
<a name="API_DescribeApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeApplication) 

# DescribeApplicationAssignment
<a name="API_DescribeApplicationAssignment"></a>

Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use [ListApplicationAssignmentsForPrincipal](API_ListApplicationAssignmentsForPrincipal.md).

## Request Syntax
<a name="API_DescribeApplicationAssignment_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "PrincipalId": "string",
   "PrincipalType": "string"
}
```

## Request Parameters
<a name="API_DescribeApplicationAssignment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_DescribeApplicationAssignment_RequestSyntax) **   <a name="singlesignon-DescribeApplicationAssignment-request-ApplicationArn"></a>
Specifies the ARN of the application. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [PrincipalId](#API_DescribeApplicationAssignment_RequestSyntax) **   <a name="singlesignon-DescribeApplicationAssignment-request-PrincipalId"></a>
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [PrincipalType](#API_DescribeApplicationAssignment_RequestSyntax) **   <a name="singlesignon-DescribeApplicationAssignment-request-PrincipalType"></a>
The entity type for which the assignment will be created.  
Type: String  
Valid Values: `USER | GROUP`   
Required: Yes

## Response Syntax
<a name="API_DescribeApplicationAssignment_ResponseSyntax"></a>

```
{
   "ApplicationArn": "string",
   "PrincipalId": "string",
   "PrincipalType": "string"
}
```

## Response Elements
<a name="API_DescribeApplicationAssignment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationArn](#API_DescribeApplicationAssignment_ResponseSyntax) **   <a name="singlesignon-DescribeApplicationAssignment-response-ApplicationArn"></a>
Specifies the ARN of the application. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}` 

 ** [PrincipalId](#API_DescribeApplicationAssignment_ResponseSyntax) **   <a name="singlesignon-DescribeApplicationAssignment-response-PrincipalId"></a>
An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [PrincipalType](#API_DescribeApplicationAssignment_ResponseSyntax) **   <a name="singlesignon-DescribeApplicationAssignment-response-PrincipalType"></a>
The entity type for which the assignment will be created.  
Type: String  
Valid Values: `USER | GROUP` 

## Errors
<a name="API_DescribeApplicationAssignment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeApplicationAssignment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeApplicationAssignment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeApplicationAssignment) 

# DescribeApplicationProvider
<a name="API_DescribeApplicationProvider"></a>

Retrieves details about a provider that can be used to connect an AWS managed application or customer managed application to IAM Identity Center.

## Request Syntax
<a name="API_DescribeApplicationProvider_RequestSyntax"></a>

```
{
   "ApplicationProviderArn": "string"
}
```

## Request Parameters
<a name="API_DescribeApplicationProvider_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationProviderArn](#API_DescribeApplicationProvider_RequestSyntax) **   <a name="singlesignon-DescribeApplicationProvider-request-ApplicationProviderArn"></a>
Specifies the ARN of the application provider for which you want details.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::aws:applicationProvider/[a-zA-Z0-9-/]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeApplicationProvider_ResponseSyntax"></a>

```
{
   "ApplicationProviderArn": "string",
   "DisplayData": { 
      "Description": "string",
      "DisplayName": "string",
      "IconUrl": "string"
   },
   "FederationProtocol": "string",
   "ResourceServerConfig": { 
      "Scopes": { 
         "string" : { 
            "DetailedTitle": "string",
            "LongDescription": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_DescribeApplicationProvider_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationProviderArn](#API_DescribeApplicationProvider_ResponseSyntax) **   <a name="singlesignon-DescribeApplicationProvider-response-ApplicationProviderArn"></a>
The ARN of the application provider.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::aws:applicationProvider/[a-zA-Z0-9-/]+` 

 ** [DisplayData](#API_DescribeApplicationProvider_ResponseSyntax) **   <a name="singlesignon-DescribeApplicationProvider-response-DisplayData"></a>
A structure with details about the display data for the application provider.  
Type: [DisplayData](API_DisplayData.md) object

 ** [FederationProtocol](#API_DescribeApplicationProvider_ResponseSyntax) **   <a name="singlesignon-DescribeApplicationProvider-response-FederationProtocol"></a>
The protocol used to federate to the application provider.  
Type: String  
Valid Values: `SAML | OAUTH` 

 ** [ResourceServerConfig](#API_DescribeApplicationProvider_ResponseSyntax) **   <a name="singlesignon-DescribeApplicationProvider-response-ResourceServerConfig"></a>
A structure with details about the receiving application.  
Type: [ResourceServerConfig](API_ResourceServerConfig.md) object

## Errors
<a name="API_DescribeApplicationProvider_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeApplicationProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeApplicationProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeApplicationProvider) 

# DescribeInstance
<a name="API_DescribeInstance"></a>

Returns the details of an instance of IAM Identity Center. The status can be one of the following:
+  `CREATE_IN_PROGRESS` - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of `ACTIVE`. While the instance is in the `CREATE_IN_PROGRESS` state, you can call only DescribeInstance and DeleteInstance operations.
+  `DELETE_IN_PROGRESS` - The instance is being deleted. Returns `AccessDeniedException` after the delete operation completes. 
+  `ACTIVE` - The instance is active.

## Request Syntax
<a name="API_DescribeInstance_RequestSyntax"></a>

```
{
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_DescribeInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DescribeInstance_RequestSyntax) **   <a name="singlesignon-DescribeInstance-request-InstanceArn"></a>
The ARN of the instance of IAM Identity Center under which the operation will run.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Syntax
<a name="API_DescribeInstance_ResponseSyntax"></a>

```
{
   "CreatedDate": number,
   "EncryptionConfigurationDetails": { 
      "EncryptionStatus": "string",
      "EncryptionStatusReason": "string",
      "KeyType": "string",
      "KmsKeyArn": "string"
   },
   "IdentityStoreId": "string",
   "InstanceArn": "string",
   "Name": "string",
   "OwnerAccountId": "string",
   "Status": "string",
   "StatusReason": "string"
}
```

## Response Elements
<a name="API_DescribeInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedDate](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-CreatedDate"></a>
The date the instance was created.  
Type: Timestamp

 ** [EncryptionConfigurationDetails](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-EncryptionConfigurationDetails"></a>
Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.  
Type: [EncryptionConfigurationDetails](API_EncryptionConfigurationDetails.md) object

 ** [IdentityStoreId](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-IdentityStoreId"></a>
The identifier of the identity store that is connected to the instance of IAM Identity Center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-]*` 

 ** [InstanceArn](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-InstanceArn"></a>
The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}` 

 ** [Name](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-Name"></a>
Specifies the instance name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\w+=,.@-]+` 

 ** [OwnerAccountId](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-OwnerAccountId"></a>
The identifier of the AWS account for which the instance was created.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [Status](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-Status"></a>
The status of the instance.   
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | DELETE_IN_PROGRESS | ACTIVE` 

 ** [StatusReason](#API_DescribeInstance_ResponseSyntax) **   <a name="singlesignon-DescribeInstance-response-StatusReason"></a>
Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE\$1FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.   
Type: String  
Pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*` 

## Errors
<a name="API_DescribeInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeInstance) 

# DescribeInstanceAccessControlAttributeConfiguration
<a name="API_DescribeInstanceAccessControlAttributeConfiguration"></a>

Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see [Attribute-Based Access Control](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center User Guide*.

## Request Syntax
<a name="API_DescribeInstanceAccessControlAttributeConfiguration_RequestSyntax"></a>

```
{
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_DescribeInstanceAccessControlAttributeConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DescribeInstanceAccessControlAttributeConfiguration_RequestSyntax) **   <a name="singlesignon-DescribeInstanceAccessControlAttributeConfiguration-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Syntax
<a name="API_DescribeInstanceAccessControlAttributeConfiguration_ResponseSyntax"></a>

```
{
   "InstanceAccessControlAttributeConfiguration": { 
      "AccessControlAttributes": [ 
         { 
            "Key": "string",
            "Value": { 
               "Source": [ "string" ]
            }
         }
      ]
   },
   "Status": "string",
   "StatusReason": "string"
}
```

## Response Elements
<a name="API_DescribeInstanceAccessControlAttributeConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceAccessControlAttributeConfiguration](#API_DescribeInstanceAccessControlAttributeConfiguration_ResponseSyntax) **   <a name="singlesignon-DescribeInstanceAccessControlAttributeConfiguration-response-InstanceAccessControlAttributeConfiguration"></a>
Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.  
Type: [InstanceAccessControlAttributeConfiguration](API_InstanceAccessControlAttributeConfiguration.md) object

 ** [Status](#API_DescribeInstanceAccessControlAttributeConfiguration_ResponseSyntax) **   <a name="singlesignon-DescribeInstanceAccessControlAttributeConfiguration-response-Status"></a>
The status of the attribute configuration process.  
Type: String  
Valid Values: `ENABLED | CREATION_IN_PROGRESS | CREATION_FAILED` 

 ** [StatusReason](#API_DescribeInstanceAccessControlAttributeConfiguration_ResponseSyntax) **   <a name="singlesignon-DescribeInstanceAccessControlAttributeConfiguration-response-StatusReason"></a>
Provides more details about the current status of the specified attribute.  
Type: String

## Errors
<a name="API_DescribeInstanceAccessControlAttributeConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeInstanceAccessControlAttributeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeInstanceAccessControlAttributeConfiguration) 

# DescribePermissionSet
<a name="API_DescribePermissionSet"></a>

Gets the details of the permission set.

## Request Syntax
<a name="API_DescribePermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_DescribePermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DescribePermissionSet_RequestSyntax) **   <a name="singlesignon-DescribePermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_DescribePermissionSet_RequestSyntax) **   <a name="singlesignon-DescribePermissionSet-request-PermissionSetArn"></a>
The ARN of the permission set.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Syntax
<a name="API_DescribePermissionSet_ResponseSyntax"></a>

```
{
   "PermissionSet": { 
      "CreatedDate": number,
      "Description": "string",
      "Name": "string",
      "PermissionSetArn": "string",
      "RelayState": "string",
      "SessionDuration": "string"
   }
}
```

## Response Elements
<a name="API_DescribePermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PermissionSet](#API_DescribePermissionSet_ResponseSyntax) **   <a name="singlesignon-DescribePermissionSet-response-PermissionSet"></a>
Describes the level of access on an AWS account.  
Type: [PermissionSet](API_PermissionSet.md) object

## Errors
<a name="API_DescribePermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribePermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribePermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribePermissionSet) 

# DescribePermissionSetProvisioningStatus
<a name="API_DescribePermissionSetProvisioningStatus"></a>

Describes the status for the given permission set provisioning request.

## Request Syntax
<a name="API_DescribePermissionSetProvisioningStatus_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "ProvisionPermissionSetRequestId": "string"
}
```

## Request Parameters
<a name="API_DescribePermissionSetProvisioningStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DescribePermissionSetProvisioningStatus_RequestSyntax) **   <a name="singlesignon-DescribePermissionSetProvisioningStatus-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [ProvisionPermissionSetRequestId](#API_DescribePermissionSetProvisioningStatus_RequestSyntax) **   <a name="singlesignon-DescribePermissionSetProvisioningStatus-request-ProvisionPermissionSetRequestId"></a>
The identifier that is provided by the [ProvisionPermissionSet](API_ProvisionPermissionSet.md) call to retrieve the current status of the provisioning workflow.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b`   
Required: Yes

## Response Syntax
<a name="API_DescribePermissionSetProvisioningStatus_ResponseSyntax"></a>

```
{
   "PermissionSetProvisioningStatus": { 
      "AccountId": "string",
      "CreatedDate": number,
      "FailureReason": "string",
      "PermissionSetArn": "string",
      "RequestId": "string",
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_DescribePermissionSetProvisioningStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PermissionSetProvisioningStatus](#API_DescribePermissionSetProvisioningStatus_ResponseSyntax) **   <a name="singlesignon-DescribePermissionSetProvisioningStatus-response-PermissionSetProvisioningStatus"></a>
The status object for the permission set provisioning operation.  
Type: [PermissionSetProvisioningStatus](API_PermissionSetProvisioningStatus.md) object

## Errors
<a name="API_DescribePermissionSetProvisioningStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribePermissionSetProvisioningStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribePermissionSetProvisioningStatus) 

# DescribeRegion
<a name="API_DescribeRegion"></a>

Retrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status (ACTIVE, ADDING, or REMOVING), the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of the IAM Identity Center instance.

The following actions are related to `DescribeRegion`:
+  [ AddRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_AddRegion.html) 
+  [RemoveRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_RemoveRegion.html) 
+  [ListRegions](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListRegions.html) 

## Request Syntax
<a name="API_DescribeRegion_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "RegionName": "string"
}
```

## Request Parameters
<a name="API_DescribeRegion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DescribeRegion_RequestSyntax) **   <a name="singlesignon-DescribeRegion-request-InstanceArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center instance.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [RegionName](#API_DescribeRegion_RequestSyntax) **   <a name="singlesignon-DescribeRegion-request-RegionName"></a>
The name of the AWS Region to retrieve information about. The Region name must be 1-32 characters long and follow the pattern of AWS Region names (for example, us-east-1).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `([a-z]+-){2,3}\d`   
Required: Yes

## Response Syntax
<a name="API_DescribeRegion_ResponseSyntax"></a>

```
{
   "AddedDate": number,
   "IsPrimaryRegion": boolean,
   "RegionName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribeRegion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AddedDate](#API_DescribeRegion_ResponseSyntax) **   <a name="singlesignon-DescribeRegion-response-AddedDate"></a>
The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the IAM Identity Center instance creation time.  
Type: Timestamp

 ** [IsPrimaryRegion](#API_DescribeRegion_ResponseSyntax) **   <a name="singlesignon-DescribeRegion-response-IsPrimaryRegion"></a>
Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. For more information on the difference between the primary Region and additional Regions, see [IAM Identity Center User Guide](https://docs.aws.amazon.com/singlesignon/latest/userguide/multi-region-iam-identity-center.html)   
Type: Boolean

 ** [RegionName](#API_DescribeRegion_ResponseSyntax) **   <a name="singlesignon-DescribeRegion-response-RegionName"></a>
The AWS Region name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `([a-z]+-){2,3}\d` 

 ** [Status](#API_DescribeRegion_ResponseSyntax) **   <a name="singlesignon-DescribeRegion-response-Status"></a>
The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region replication workflow is in progress), or REMOVING (Region removal workflow is in progress).  
Type: String  
Valid Values: `ACTIVE | ADDING | REMOVING` 

## Errors
<a name="API_DescribeRegion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeRegion) 

# DescribeTrustedTokenIssuer
<a name="API_DescribeTrustedTokenIssuer"></a>

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration. 

## Request Syntax
<a name="API_DescribeTrustedTokenIssuer_RequestSyntax"></a>

```
{
   "TrustedTokenIssuerArn": "string"
}
```

## Request Parameters
<a name="API_DescribeTrustedTokenIssuer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TrustedTokenIssuerArn](#API_DescribeTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-DescribeTrustedTokenIssuer-request-TrustedTokenIssuerArn"></a>
Specifies the ARN of the trusted token issuer configuration that you want details about.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Response Syntax
<a name="API_DescribeTrustedTokenIssuer_ResponseSyntax"></a>

```
{
   "Name": "string",
   "TrustedTokenIssuerArn": "string",
   "TrustedTokenIssuerConfiguration": { ... },
   "TrustedTokenIssuerType": "string"
}
```

## Response Elements
<a name="API_DescribeTrustedTokenIssuer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Name](#API_DescribeTrustedTokenIssuer_ResponseSyntax) **   <a name="singlesignon-DescribeTrustedTokenIssuer-response-Name"></a>
The name of the trusted token issuer configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\w+=,.@-]+` 

 ** [TrustedTokenIssuerArn](#API_DescribeTrustedTokenIssuer_ResponseSyntax) **   <a name="singlesignon-DescribeTrustedTokenIssuer-response-TrustedTokenIssuerArn"></a>
The ARN of the trusted token issuer configuration.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [TrustedTokenIssuerConfiguration](#API_DescribeTrustedTokenIssuer_ResponseSyntax) **   <a name="singlesignon-DescribeTrustedTokenIssuer-response-TrustedTokenIssuerConfiguration"></a>
A structure the describes the settings that apply of this trusted token issuer.  
Type: [TrustedTokenIssuerConfiguration](API_TrustedTokenIssuerConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [TrustedTokenIssuerType](#API_DescribeTrustedTokenIssuer_ResponseSyntax) **   <a name="singlesignon-DescribeTrustedTokenIssuer-response-TrustedTokenIssuerType"></a>
The type of the trusted token issuer.  
Type: String  
Valid Values: `OIDC_JWT` 

## Errors
<a name="API_DescribeTrustedTokenIssuer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DescribeTrustedTokenIssuer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DescribeTrustedTokenIssuer) 

# DetachCustomerManagedPolicyReferenceFromPermissionSet
<a name="API_DetachCustomerManagedPolicyReferenceFromPermissionSet"></a>

Detaches the specified customer managed policy from the specified [PermissionSet](API_PermissionSet.md).

## Request Syntax
<a name="API_DetachCustomerManagedPolicyReferenceFromPermissionSet_RequestSyntax"></a>

```
{
   "CustomerManagedPolicyReference": { 
      "Name": "string",
      "Path": "string"
   },
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_DetachCustomerManagedPolicyReferenceFromPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CustomerManagedPolicyReference](#API_DetachCustomerManagedPolicyReferenceFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DetachCustomerManagedPolicyReferenceFromPermissionSet-request-CustomerManagedPolicyReference"></a>
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.  
Type: [CustomerManagedPolicyReference](API_CustomerManagedPolicyReference.md) object  
Required: Yes

 ** [InstanceArn](#API_DetachCustomerManagedPolicyReferenceFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DetachCustomerManagedPolicyReferenceFromPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_DetachCustomerManagedPolicyReferenceFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DetachCustomerManagedPolicyReferenceFromPermissionSet-request-PermissionSetArn"></a>
The ARN of the `PermissionSet`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_DetachCustomerManagedPolicyReferenceFromPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DetachCustomerManagedPolicyReferenceFromPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DetachCustomerManagedPolicyReferenceFromPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DetachCustomerManagedPolicyReferenceFromPermissionSet) 

# DetachManagedPolicyFromPermissionSet
<a name="API_DetachManagedPolicyFromPermissionSet"></a>

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

## Request Syntax
<a name="API_DetachManagedPolicyFromPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "ManagedPolicyArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_DetachManagedPolicyFromPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_DetachManagedPolicyFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DetachManagedPolicyFromPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [ManagedPolicyArn](#API_DetachManagedPolicyFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DetachManagedPolicyFromPermissionSet-request-ManagedPolicyArn"></a>
The AWS managed policy ARN to be detached from a permission set.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:iam::aws:policy((/[A-Za-z0-9\.,\+@=_-]+)*)/([A-Za-z0-9\.,\+=@_-]+)`   
Required: Yes

 ** [PermissionSetArn](#API_DetachManagedPolicyFromPermissionSet_RequestSyntax) **   <a name="singlesignon-DetachManagedPolicyFromPermissionSet-request-PermissionSetArn"></a>
The ARN of the [PermissionSet](API_PermissionSet.md) from which the policy should be detached.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_DetachManagedPolicyFromPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DetachManagedPolicyFromPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_DetachManagedPolicyFromPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/DetachManagedPolicyFromPermissionSet) 

# GetApplicationAccessScope
<a name="API_GetApplicationAccessScope"></a>

Retrieves the authorized targets for an IAM Identity Center access scope for an application.

## Request Syntax
<a name="API_GetApplicationAccessScope_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "Scope": "string"
}
```

## Request Parameters
<a name="API_GetApplicationAccessScope_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_GetApplicationAccessScope_RequestSyntax) **   <a name="singlesignon-GetApplicationAccessScope-request-ApplicationArn"></a>
Specifies the ARN of the application with the access scope that you want to retrieve.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [Scope](#API_GetApplicationAccessScope_RequestSyntax) **   <a name="singlesignon-GetApplicationAccessScope-request-Scope"></a>
Specifies the name of the access scope for which you want the authorized targets.  
Type: String  
Pattern: `([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}`   
Required: Yes

## Response Syntax
<a name="API_GetApplicationAccessScope_ResponseSyntax"></a>

```
{
   "AuthorizedTargets": [ "string" ],
   "Scope": "string"
}
```

## Response Elements
<a name="API_GetApplicationAccessScope_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthorizedTargets](#API_GetApplicationAccessScope_ResponseSyntax) **   <a name="singlesignon-GetApplicationAccessScope-response-AuthorizedTargets"></a>
An array of authorized targets associated with this access scope.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::(\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}|:instance/(sso)?ins-[a-zA-Z0-9-.]{16})` 

 ** [Scope](#API_GetApplicationAccessScope_ResponseSyntax) **   <a name="singlesignon-GetApplicationAccessScope-response-Scope"></a>
The name of the access scope that can be used with the authorized targets.  
Type: String  
Pattern: `([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}` 

## Errors
<a name="API_GetApplicationAccessScope_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_GetApplicationAccessScope_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/GetApplicationAccessScope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/GetApplicationAccessScope) 

# GetApplicationAssignmentConfiguration
<a name="API_GetApplicationAssignmentConfiguration"></a>

Retrieves the configuration of [PutApplicationAssignmentConfiguration](API_PutApplicationAssignmentConfiguration.md).

## Request Syntax
<a name="API_GetApplicationAssignmentConfiguration_RequestSyntax"></a>

```
{
   "ApplicationArn": "string"
}
```

## Request Parameters
<a name="API_GetApplicationAssignmentConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_GetApplicationAssignmentConfiguration_RequestSyntax) **   <a name="singlesignon-GetApplicationAssignmentConfiguration-request-ApplicationArn"></a>
Specifies the ARN of the application. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

## Response Syntax
<a name="API_GetApplicationAssignmentConfiguration_ResponseSyntax"></a>

```
{
   "AssignmentRequired": boolean
}
```

## Response Elements
<a name="API_GetApplicationAssignmentConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssignmentRequired](#API_GetApplicationAssignmentConfiguration_ResponseSyntax) **   <a name="singlesignon-GetApplicationAssignmentConfiguration-response-AssignmentRequired"></a>
If `AssignmentsRequired` is `true` (default value), users don’t have access to the application unless an assignment is created using the [CreateApplicationAssignment API](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html). If `false`, all users have access to the application.   
Type: Boolean

## Errors
<a name="API_GetApplicationAssignmentConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_GetApplicationAssignmentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/GetApplicationAssignmentConfiguration) 

# GetApplicationAuthenticationMethod
<a name="API_GetApplicationAuthenticationMethod"></a>

Retrieves details about an authentication method used by an application.

## Request Syntax
<a name="API_GetApplicationAuthenticationMethod_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "AuthenticationMethodType": "string"
}
```

## Request Parameters
<a name="API_GetApplicationAuthenticationMethod_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_GetApplicationAuthenticationMethod_RequestSyntax) **   <a name="singlesignon-GetApplicationAuthenticationMethod-request-ApplicationArn"></a>
Specifies the ARN of the application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [AuthenticationMethodType](#API_GetApplicationAuthenticationMethod_RequestSyntax) **   <a name="singlesignon-GetApplicationAuthenticationMethod-request-AuthenticationMethodType"></a>
Specifies the type of authentication method for which you want details.  
Type: String  
Valid Values: `IAM`   
Required: Yes

## Response Syntax
<a name="API_GetApplicationAuthenticationMethod_ResponseSyntax"></a>

```
{
   "AuthenticationMethod": { ... }
}
```

## Response Elements
<a name="API_GetApplicationAuthenticationMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthenticationMethod](#API_GetApplicationAuthenticationMethod_ResponseSyntax) **   <a name="singlesignon-GetApplicationAuthenticationMethod-response-AuthenticationMethod"></a>
A structure that contains details about the requested authentication method.  
Type: [AuthenticationMethod](API_AuthenticationMethod.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

## Errors
<a name="API_GetApplicationAuthenticationMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_GetApplicationAuthenticationMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/GetApplicationAuthenticationMethod) 

# GetApplicationGrant
<a name="API_GetApplicationGrant"></a>

Retrieves details about an application grant.

## Request Syntax
<a name="API_GetApplicationGrant_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "GrantType": "string"
}
```

## Request Parameters
<a name="API_GetApplicationGrant_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_GetApplicationGrant_RequestSyntax) **   <a name="singlesignon-GetApplicationGrant-request-ApplicationArn"></a>
Specifies the ARN of the application that contains the grant.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [GrantType](#API_GetApplicationGrant_RequestSyntax) **   <a name="singlesignon-GetApplicationGrant-request-GrantType"></a>
Specifies the type of grant.  
Type: String  
Valid Values: `authorization_code | refresh_token | urn:ietf:params:oauth:grant-type:jwt-bearer | urn:ietf:params:oauth:grant-type:token-exchange`   
Required: Yes

## Response Syntax
<a name="API_GetApplicationGrant_ResponseSyntax"></a>

```
{
   "Grant": { ... }
}
```

## Response Elements
<a name="API_GetApplicationGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Grant](#API_GetApplicationGrant_ResponseSyntax) **   <a name="singlesignon-GetApplicationGrant-response-Grant"></a>
A structure that describes the requested grant.  
Type: [Grant](API_Grant.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

## Errors
<a name="API_GetApplicationGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_GetApplicationGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/GetApplicationGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/GetApplicationGrant) 

# GetApplicationSessionConfiguration
<a name="API_GetApplicationSessionConfiguration"></a>

Retrieves the session configuration for an application in IAM Identity Center.

The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported AWS managed application without having to remain signed in to an active session while the job runs.

## Request Syntax
<a name="API_GetApplicationSessionConfiguration_RequestSyntax"></a>

```
{
   "ApplicationArn": "string"
}
```

## Request Parameters
<a name="API_GetApplicationSessionConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_GetApplicationSessionConfiguration_RequestSyntax) **   <a name="singlesignon-GetApplicationSessionConfiguration-request-ApplicationArn"></a>
The Amazon Resource Name (ARN) of the application for which to retrieve the session configuration.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

## Response Syntax
<a name="API_GetApplicationSessionConfiguration_ResponseSyntax"></a>

```
{
   "UserBackgroundSessionApplicationStatus": "string"
}
```

## Response Elements
<a name="API_GetApplicationSessionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [UserBackgroundSessionApplicationStatus](#API_GetApplicationSessionConfiguration_ResponseSyntax) **   <a name="singlesignon-GetApplicationSessionConfiguration-response-UserBackgroundSessionApplicationStatus"></a>
The status of user background sessions for the application.   
Type: String  
Valid Values: `ENABLED | DISABLED` 

## Errors
<a name="API_GetApplicationSessionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_GetApplicationSessionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/GetApplicationSessionConfiguration) 

# GetInlinePolicyForPermissionSet
<a name="API_GetInlinePolicyForPermissionSet"></a>

Obtains the inline policy assigned to the permission set.

## Request Syntax
<a name="API_GetInlinePolicyForPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_GetInlinePolicyForPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_GetInlinePolicyForPermissionSet_RequestSyntax) **   <a name="singlesignon-GetInlinePolicyForPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_GetInlinePolicyForPermissionSet_RequestSyntax) **   <a name="singlesignon-GetInlinePolicyForPermissionSet-request-PermissionSetArn"></a>
The ARN of the permission set.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Syntax
<a name="API_GetInlinePolicyForPermissionSet_ResponseSyntax"></a>

```
{
   "InlinePolicy": "string"
}
```

## Response Elements
<a name="API_GetInlinePolicyForPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InlinePolicy](#API_GetInlinePolicyForPermissionSet_ResponseSyntax) **   <a name="singlesignon-GetInlinePolicyForPermissionSet-response-InlinePolicy"></a>
The inline policy that is attached to the permission set.  
For `Length Constraints`, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+` 

## Errors
<a name="API_GetInlinePolicyForPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_GetInlinePolicyForPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/GetInlinePolicyForPermissionSet) 

# GetPermissionsBoundaryForPermissionSet
<a name="API_GetPermissionsBoundaryForPermissionSet"></a>

Obtains the permissions boundary for a specified [PermissionSet](API_PermissionSet.md).

## Request Syntax
<a name="API_GetPermissionsBoundaryForPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_GetPermissionsBoundaryForPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_GetPermissionsBoundaryForPermissionSet_RequestSyntax) **   <a name="singlesignon-GetPermissionsBoundaryForPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_GetPermissionsBoundaryForPermissionSet_RequestSyntax) **   <a name="singlesignon-GetPermissionsBoundaryForPermissionSet-request-PermissionSetArn"></a>
The ARN of the `PermissionSet`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Syntax
<a name="API_GetPermissionsBoundaryForPermissionSet_ResponseSyntax"></a>

```
{
   "PermissionsBoundary": { 
      "CustomerManagedPolicyReference": { 
         "Name": "string",
         "Path": "string"
      },
      "ManagedPolicyArn": "string"
   }
}
```

## Response Elements
<a name="API_GetPermissionsBoundaryForPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PermissionsBoundary](#API_GetPermissionsBoundaryForPermissionSet_ResponseSyntax) **   <a name="singlesignon-GetPermissionsBoundaryForPermissionSet-response-PermissionsBoundary"></a>
The permissions boundary attached to the specified permission set.  
Type: [PermissionsBoundary](API_PermissionsBoundary.md) object

## Errors
<a name="API_GetPermissionsBoundaryForPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_GetPermissionsBoundaryForPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/GetPermissionsBoundaryForPermissionSet) 

# ListAccountAssignmentCreationStatus
<a name="API_ListAccountAssignmentCreationStatus"></a>

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

## Request Syntax
<a name="API_ListAccountAssignmentCreationStatus_RequestSyntax"></a>

```
{
   "Filter": { 
      "Status": "string"
   },
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListAccountAssignmentCreationStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListAccountAssignmentCreationStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentCreationStatus-request-Filter"></a>
Filters results based on the passed attribute value.  
Type: [OperationStatusFilter](API_OperationStatusFilter.md) object  
Required: No

 ** [InstanceArn](#API_ListAccountAssignmentCreationStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentCreationStatus-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListAccountAssignmentCreationStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentCreationStatus-request-MaxResults"></a>
The maximum number of results to display for the assignment.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListAccountAssignmentCreationStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentCreationStatus-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListAccountAssignmentCreationStatus_ResponseSyntax"></a>

```
{
   "AccountAssignmentsCreationStatus": [ 
      { 
         "CreatedDate": number,
         "RequestId": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAccountAssignmentCreationStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignmentsCreationStatus](#API_ListAccountAssignmentCreationStatus_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignmentCreationStatus-response-AccountAssignmentsCreationStatus"></a>
The status object for the account assignment creation operation.  
Type: Array of [AccountAssignmentOperationStatusMetadata](API_AccountAssignmentOperationStatusMetadata.md) objects

 ** [NextToken](#API_ListAccountAssignmentCreationStatus_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignmentCreationStatus-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListAccountAssignmentCreationStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListAccountAssignmentCreationStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListAccountAssignmentCreationStatus) 

# ListAccountAssignmentDeletionStatus
<a name="API_ListAccountAssignmentDeletionStatus"></a>

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

## Request Syntax
<a name="API_ListAccountAssignmentDeletionStatus_RequestSyntax"></a>

```
{
   "Filter": { 
      "Status": "string"
   },
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListAccountAssignmentDeletionStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListAccountAssignmentDeletionStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentDeletionStatus-request-Filter"></a>
Filters results based on the passed attribute value.  
Type: [OperationStatusFilter](API_OperationStatusFilter.md) object  
Required: No

 ** [InstanceArn](#API_ListAccountAssignmentDeletionStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentDeletionStatus-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListAccountAssignmentDeletionStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentDeletionStatus-request-MaxResults"></a>
The maximum number of results to display for the assignment.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListAccountAssignmentDeletionStatus_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentDeletionStatus-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListAccountAssignmentDeletionStatus_ResponseSyntax"></a>

```
{
   "AccountAssignmentsDeletionStatus": [ 
      { 
         "CreatedDate": number,
         "RequestId": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAccountAssignmentDeletionStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignmentsDeletionStatus](#API_ListAccountAssignmentDeletionStatus_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignmentDeletionStatus-response-AccountAssignmentsDeletionStatus"></a>
The status object for the account assignment deletion operation.  
Type: Array of [AccountAssignmentOperationStatusMetadata](API_AccountAssignmentOperationStatusMetadata.md) objects

 ** [NextToken](#API_ListAccountAssignmentDeletionStatus_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignmentDeletionStatus-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListAccountAssignmentDeletionStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListAccountAssignmentDeletionStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListAccountAssignmentDeletionStatus) 

# ListAccountAssignments
<a name="API_ListAccountAssignments"></a>

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

## Request Syntax
<a name="API_ListAccountAssignments_RequestSyntax"></a>

```
{
   "AccountId": "string",
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_ListAccountAssignments_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccountId](#API_ListAccountAssignments_RequestSyntax) **   <a name="singlesignon-ListAccountAssignments-request-AccountId"></a>
The identifier of the AWS account from which to list the assignments.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: Yes

 ** [InstanceArn](#API_ListAccountAssignments_RequestSyntax) **   <a name="singlesignon-ListAccountAssignments-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListAccountAssignments_RequestSyntax) **   <a name="singlesignon-ListAccountAssignments-request-MaxResults"></a>
The maximum number of results to display for the assignment.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListAccountAssignments_RequestSyntax) **   <a name="singlesignon-ListAccountAssignments-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [PermissionSetArn](#API_ListAccountAssignments_RequestSyntax) **   <a name="singlesignon-ListAccountAssignments-request-PermissionSetArn"></a>
The ARN of the permission set from which to list assignments.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Syntax
<a name="API_ListAccountAssignments_ResponseSyntax"></a>

```
{
   "AccountAssignments": [ 
      { 
         "AccountId": "string",
         "PermissionSetArn": "string",
         "PrincipalId": "string",
         "PrincipalType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAccountAssignments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignments](#API_ListAccountAssignments_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignments-response-AccountAssignments"></a>
The list of assignments that match the input AWS account and permission set.  
Type: Array of [AccountAssignment](API_AccountAssignment.md) objects

 ** [NextToken](#API_ListAccountAssignments_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignments-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListAccountAssignments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListAccountAssignments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListAccountAssignments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListAccountAssignments) 

# ListAccountAssignmentsForPrincipal
<a name="API_ListAccountAssignmentsForPrincipal"></a>

Retrieves a list of the IAM Identity Center associated AWS accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.

## Request Syntax
<a name="API_ListAccountAssignmentsForPrincipal_RequestSyntax"></a>

```
{
   "Filter": { 
      "AccountId": "string"
   },
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PrincipalId": "string",
   "PrincipalType": "string"
}
```

## Request Parameters
<a name="API_ListAccountAssignmentsForPrincipal_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListAccountAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-request-Filter"></a>
Specifies an AWS account ID number. Results are filtered to only those that match this ID number.  
Type: [ListAccountAssignmentsFilter](API_ListAccountAssignmentsFilter.md) object  
Required: No

 ** [InstanceArn](#API_ListAccountAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-request-InstanceArn"></a>
Specifies the ARN of the instance of IAM Identity Center that contains the principal.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListAccountAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-request-MaxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListAccountAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [PrincipalId](#API_ListAccountAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-request-PrincipalId"></a>
Specifies the principal for which you want to retrieve the list of account assignments.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [PrincipalType](#API_ListAccountAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-request-PrincipalType"></a>
Specifies the type of the principal.  
Type: String  
Valid Values: `USER | GROUP`   
Required: Yes

## Response Syntax
<a name="API_ListAccountAssignmentsForPrincipal_ResponseSyntax"></a>

```
{
   "AccountAssignments": [ 
      { 
         "AccountId": "string",
         "PermissionSetArn": "string",
         "PrincipalId": "string",
         "PrincipalType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAccountAssignmentsForPrincipal_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountAssignments](#API_ListAccountAssignmentsForPrincipal_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-response-AccountAssignments"></a>
An array list of the account assignments for the principal.  
Type: Array of [AccountAssignmentForPrincipal](API_AccountAssignmentForPrincipal.md) objects

 ** [NextToken](#API_ListAccountAssignmentsForPrincipal_ResponseSyntax) **   <a name="singlesignon-ListAccountAssignmentsForPrincipal-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListAccountAssignmentsForPrincipal_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListAccountAssignmentsForPrincipal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListAccountAssignmentsForPrincipal) 

# ListAccountsForProvisionedPermissionSet
<a name="API_ListAccountsForProvisionedPermissionSet"></a>

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

## Request Syntax
<a name="API_ListAccountsForProvisionedPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PermissionSetArn": "string",
   "ProvisioningStatus": "string"
}
```

## Request Parameters
<a name="API_ListAccountsForProvisionedPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ListAccountsForProvisionedPermissionSet_RequestSyntax) **   <a name="singlesignon-ListAccountsForProvisionedPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListAccountsForProvisionedPermissionSet_RequestSyntax) **   <a name="singlesignon-ListAccountsForProvisionedPermissionSet-request-MaxResults"></a>
The maximum number of results to display for the [PermissionSet](API_PermissionSet.md).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListAccountsForProvisionedPermissionSet_RequestSyntax) **   <a name="singlesignon-ListAccountsForProvisionedPermissionSet-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [PermissionSetArn](#API_ListAccountsForProvisionedPermissionSet_RequestSyntax) **   <a name="singlesignon-ListAccountsForProvisionedPermissionSet-request-PermissionSetArn"></a>
The ARN of the [PermissionSet](API_PermissionSet.md) from which the associated AWS accounts will be listed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

 ** [ProvisioningStatus](#API_ListAccountsForProvisionedPermissionSet_RequestSyntax) **   <a name="singlesignon-ListAccountsForProvisionedPermissionSet-request-ProvisioningStatus"></a>
The permission set provisioning status for an AWS account.  
Type: String  
Valid Values: `LATEST_PERMISSION_SET_PROVISIONED | LATEST_PERMISSION_SET_NOT_PROVISIONED`   
Required: No

## Response Syntax
<a name="API_ListAccountsForProvisionedPermissionSet_ResponseSyntax"></a>

```
{
   "AccountIds": [ "string" ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAccountsForProvisionedPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountIds](#API_ListAccountsForProvisionedPermissionSet_ResponseSyntax) **   <a name="singlesignon-ListAccountsForProvisionedPermissionSet-response-AccountIds"></a>
The list of AWS `AccountIds`.  
Type: Array of strings  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}` 

 ** [NextToken](#API_ListAccountsForProvisionedPermissionSet_ResponseSyntax) **   <a name="singlesignon-ListAccountsForProvisionedPermissionSet-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListAccountsForProvisionedPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListAccountsForProvisionedPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListAccountsForProvisionedPermissionSet) 

# ListApplicationAccessScopes
<a name="API_ListApplicationAccessScopes"></a>

Lists the access scopes and authorized targets associated with an application.

## Request Syntax
<a name="API_ListApplicationAccessScopes_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListApplicationAccessScopes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_ListApplicationAccessScopes_RequestSyntax) **   <a name="singlesignon-ListApplicationAccessScopes-request-ApplicationArn"></a>
Specifies the ARN of the application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [MaxResults](#API_ListApplicationAccessScopes_RequestSyntax) **   <a name="singlesignon-ListApplicationAccessScopes-request-MaxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_ListApplicationAccessScopes_RequestSyntax) **   <a name="singlesignon-ListApplicationAccessScopes-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListApplicationAccessScopes_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Scopes": [ 
      { 
         "AuthorizedTargets": [ "string" ],
         "Scope": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListApplicationAccessScopes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListApplicationAccessScopes_ResponseSyntax) **   <a name="singlesignon-ListApplicationAccessScopes-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

 ** [Scopes](#API_ListApplicationAccessScopes_ResponseSyntax) **   <a name="singlesignon-ListApplicationAccessScopes-response-Scopes"></a>
An array list of access scopes and their authorized targets that are associated with the application.  
Type: Array of [ScopeDetails](API_ScopeDetails.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

## Errors
<a name="API_ListApplicationAccessScopes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListApplicationAccessScopes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListApplicationAccessScopes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListApplicationAccessScopes) 

# ListApplicationAssignments
<a name="API_ListApplicationAssignments"></a>

Lists AWS account users that are assigned to an application.

## Request Syntax
<a name="API_ListApplicationAssignments_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListApplicationAssignments_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_ListApplicationAssignments_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignments-request-ApplicationArn"></a>
Specifies the ARN of the application.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [MaxResults](#API_ListApplicationAssignments_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignments-request-MaxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListApplicationAssignments_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignments-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListApplicationAssignments_ResponseSyntax"></a>

```
{
   "ApplicationAssignments": [ 
      { 
         "ApplicationArn": "string",
         "PrincipalId": "string",
         "PrincipalType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplicationAssignments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationAssignments](#API_ListApplicationAssignments_ResponseSyntax) **   <a name="singlesignon-ListApplicationAssignments-response-ApplicationAssignments"></a>
The list of users assigned to an application.  
Type: Array of [ApplicationAssignment](API_ApplicationAssignment.md) objects

 ** [NextToken](#API_ListApplicationAssignments_ResponseSyntax) **   <a name="singlesignon-ListApplicationAssignments-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListApplicationAssignments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListApplicationAssignments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListApplicationAssignments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListApplicationAssignments) 

# ListApplicationAssignmentsForPrincipal
<a name="API_ListApplicationAssignmentsForPrincipal"></a>

Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.

## Request Syntax
<a name="API_ListApplicationAssignmentsForPrincipal_RequestSyntax"></a>

```
{
   "Filter": { 
      "ApplicationArn": "string"
   },
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PrincipalId": "string",
   "PrincipalType": "string"
}
```

## Request Parameters
<a name="API_ListApplicationAssignmentsForPrincipal_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListApplicationAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-request-Filter"></a>
Filters the output to include only assignments associated with the application that has the specified ARN.  
Type: [ListApplicationAssignmentsFilter](API_ListApplicationAssignmentsFilter.md) object  
Required: No

 ** [InstanceArn](#API_ListApplicationAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-request-InstanceArn"></a>
Specifies the instance of IAM Identity Center that contains principal and applications.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListApplicationAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-request-MaxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListApplicationAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [PrincipalId](#API_ListApplicationAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-request-PrincipalId"></a>
Specifies the unique identifier of the principal for which you want to retrieve its assignments.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 47.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`   
Required: Yes

 ** [PrincipalType](#API_ListApplicationAssignmentsForPrincipal_RequestSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-request-PrincipalType"></a>
Specifies the type of the principal for which you want to retrieve its assignments.  
Type: String  
Valid Values: `USER | GROUP`   
Required: Yes

## Response Syntax
<a name="API_ListApplicationAssignmentsForPrincipal_ResponseSyntax"></a>

```
{
   "ApplicationAssignments": [ 
      { 
         "ApplicationArn": "string",
         "PrincipalId": "string",
         "PrincipalType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplicationAssignmentsForPrincipal_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationAssignments](#API_ListApplicationAssignmentsForPrincipal_ResponseSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-response-ApplicationAssignments"></a>
An array list of the application assignments for the specified principal.  
Type: Array of [ApplicationAssignmentForPrincipal](API_ApplicationAssignmentForPrincipal.md) objects

 ** [NextToken](#API_ListApplicationAssignmentsForPrincipal_ResponseSyntax) **   <a name="singlesignon-ListApplicationAssignmentsForPrincipal-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListApplicationAssignmentsForPrincipal_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListApplicationAssignmentsForPrincipal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListApplicationAssignmentsForPrincipal) 

# ListApplicationAuthenticationMethods
<a name="API_ListApplicationAuthenticationMethods"></a>

Lists all of the authentication methods supported by the specified application.

## Request Syntax
<a name="API_ListApplicationAuthenticationMethods_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListApplicationAuthenticationMethods_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_ListApplicationAuthenticationMethods_RequestSyntax) **   <a name="singlesignon-ListApplicationAuthenticationMethods-request-ApplicationArn"></a>
Specifies the ARN of the application with the authentication methods you want to list.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [NextToken](#API_ListApplicationAuthenticationMethods_RequestSyntax) **   <a name="singlesignon-ListApplicationAuthenticationMethods-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListApplicationAuthenticationMethods_ResponseSyntax"></a>

```
{
   "AuthenticationMethods": [ 
      { 
         "AuthenticationMethod": { ... },
         "AuthenticationMethodType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplicationAuthenticationMethods_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthenticationMethods](#API_ListApplicationAuthenticationMethods_ResponseSyntax) **   <a name="singlesignon-ListApplicationAuthenticationMethods-response-AuthenticationMethods"></a>
An array list of authentication methods for the specified application.  
Type: Array of [AuthenticationMethodItem](API_AuthenticationMethodItem.md) objects

 ** [NextToken](#API_ListApplicationAuthenticationMethods_ResponseSyntax) **   <a name="singlesignon-ListApplicationAuthenticationMethods-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListApplicationAuthenticationMethods_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListApplicationAuthenticationMethods_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListApplicationAuthenticationMethods) 

# ListApplicationGrants
<a name="API_ListApplicationGrants"></a>

List the grants associated with an application.

## Request Syntax
<a name="API_ListApplicationGrants_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListApplicationGrants_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_ListApplicationGrants_RequestSyntax) **   <a name="singlesignon-ListApplicationGrants-request-ApplicationArn"></a>
Specifies the ARN of the application whose grants you want to list.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [NextToken](#API_ListApplicationGrants_RequestSyntax) **   <a name="singlesignon-ListApplicationGrants-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListApplicationGrants_ResponseSyntax"></a>

```
{
   "Grants": [ 
      { 
         "Grant": { ... },
         "GrantType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplicationGrants_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Grants](#API_ListApplicationGrants_ResponseSyntax) **   <a name="singlesignon-ListApplicationGrants-response-Grants"></a>
An array list of structures that describe the requested grants.  
Type: Array of [GrantItem](API_GrantItem.md) objects

 ** [NextToken](#API_ListApplicationGrants_ResponseSyntax) **   <a name="singlesignon-ListApplicationGrants-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListApplicationGrants_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListApplicationGrants_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListApplicationGrants) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListApplicationGrants) 

# ListApplicationProviders
<a name="API_ListApplicationProviders"></a>

Lists the application providers configured in the IAM Identity Center identity store.

## Request Syntax
<a name="API_ListApplicationProviders_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListApplicationProviders_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListApplicationProviders_RequestSyntax) **   <a name="singlesignon-ListApplicationProviders-request-MaxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListApplicationProviders_RequestSyntax) **   <a name="singlesignon-ListApplicationProviders-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListApplicationProviders_ResponseSyntax"></a>

```
{
   "ApplicationProviders": [ 
      { 
         "ApplicationProviderArn": "string",
         "DisplayData": { 
            "Description": "string",
            "DisplayName": "string",
            "IconUrl": "string"
         },
         "FederationProtocol": "string",
         "ResourceServerConfig": { 
            "Scopes": { 
               "string" : { 
                  "DetailedTitle": "string",
                  "LongDescription": "string"
               }
            }
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplicationProviders_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationProviders](#API_ListApplicationProviders_ResponseSyntax) **   <a name="singlesignon-ListApplicationProviders-response-ApplicationProviders"></a>
An array list of structures that describe application providers.  
Type: Array of [ApplicationProvider](API_ApplicationProvider.md) objects

 ** [NextToken](#API_ListApplicationProviders_ResponseSyntax) **   <a name="singlesignon-ListApplicationProviders-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListApplicationProviders_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListApplicationProviders_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListApplicationProviders) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListApplicationProviders) 

# ListApplications
<a name="API_ListApplications"></a>

Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the `applicationAccount` parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.

## Request Syntax
<a name="API_ListApplications_RequestSyntax"></a>

```
{
   "Filter": { 
      "ApplicationAccount": "string",
      "ApplicationProvider": "string"
   },
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListApplications_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListApplications_RequestSyntax) **   <a name="singlesignon-ListApplications-request-Filter"></a>
Filters response results.   
Type: [ListApplicationsFilter](API_ListApplicationsFilter.md) object  
Required: No

 ** [InstanceArn](#API_ListApplications_RequestSyntax) **   <a name="singlesignon-ListApplications-request-InstanceArn"></a>
The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListApplications_RequestSyntax) **   <a name="singlesignon-ListApplications-request-MaxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListApplications_RequestSyntax) **   <a name="singlesignon-ListApplications-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListApplications_ResponseSyntax"></a>

```
{
   "Applications": [ 
      { 
         "ApplicationAccount": "string",
         "ApplicationArn": "string",
         "ApplicationProviderArn": "string",
         "CreatedDate": number,
         "CreatedFrom": "string",
         "Description": "string",
         "InstanceArn": "string",
         "Name": "string",
         "PortalOptions": { 
            "SignInOptions": { 
               "ApplicationUrl": "string",
               "Origin": "string"
            },
            "Visibility": "string"
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApplications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Applications](#API_ListApplications_ResponseSyntax) **   <a name="singlesignon-ListApplications-response-Applications"></a>
Retrieves all applications associated with the instance.  
Type: Array of [Application](API_Application.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [NextToken](#API_ListApplications_ResponseSyntax) **   <a name="singlesignon-ListApplications-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListApplications) 

# ListCustomerManagedPolicyReferencesInPermissionSet
<a name="API_ListCustomerManagedPolicyReferencesInPermissionSet"></a>

Lists all customer managed policies attached to a specified [PermissionSet](API_PermissionSet.md).

## Request Syntax
<a name="API_ListCustomerManagedPolicyReferencesInPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_ListCustomerManagedPolicyReferencesInPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ListCustomerManagedPolicyReferencesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListCustomerManagedPolicyReferencesInPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListCustomerManagedPolicyReferencesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListCustomerManagedPolicyReferencesInPermissionSet-request-MaxResults"></a>
The maximum number of results to display for the list call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListCustomerManagedPolicyReferencesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListCustomerManagedPolicyReferencesInPermissionSet-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [PermissionSetArn](#API_ListCustomerManagedPolicyReferencesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListCustomerManagedPolicyReferencesInPermissionSet-request-PermissionSetArn"></a>
The ARN of the `PermissionSet`.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Syntax
<a name="API_ListCustomerManagedPolicyReferencesInPermissionSet_ResponseSyntax"></a>

```
{
   "CustomerManagedPolicyReferences": [ 
      { 
         "Name": "string",
         "Path": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListCustomerManagedPolicyReferencesInPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CustomerManagedPolicyReferences](#API_ListCustomerManagedPolicyReferencesInPermissionSet_ResponseSyntax) **   <a name="singlesignon-ListCustomerManagedPolicyReferencesInPermissionSet-response-CustomerManagedPolicyReferences"></a>
Specifies the names and paths of the customer managed policies that you have attached to your permission set.  
Type: Array of [CustomerManagedPolicyReference](API_CustomerManagedPolicyReference.md) objects

 ** [NextToken](#API_ListCustomerManagedPolicyReferencesInPermissionSet_ResponseSyntax) **   <a name="singlesignon-ListCustomerManagedPolicyReferencesInPermissionSet-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListCustomerManagedPolicyReferencesInPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListCustomerManagedPolicyReferencesInPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListCustomerManagedPolicyReferencesInPermissionSet) 

# ListInstances
<a name="API_ListInstances"></a>

Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API. 

## Request Syntax
<a name="API_ListInstances_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListInstances_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListInstances_RequestSyntax) **   <a name="singlesignon-ListInstances-request-MaxResults"></a>
The maximum number of results to display for the instance.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListInstances_RequestSyntax) **   <a name="singlesignon-ListInstances-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListInstances_ResponseSyntax"></a>

```
{
   "Instances": [ 
      { 
         "CreatedDate": number,
         "IdentityStoreId": "string",
         "InstanceArn": "string",
         "Name": "string",
         "OwnerAccountId": "string",
         "Status": "string",
         "StatusReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Instances](#API_ListInstances_ResponseSyntax) **   <a name="singlesignon-ListInstances-response-Instances"></a>
Lists the IAM Identity Center instances that the caller has access to.  
Type: Array of [InstanceMetadata](API_InstanceMetadata.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [NextToken](#API_ListInstances_ResponseSyntax) **   <a name="singlesignon-ListInstances-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListInstances) 

# ListManagedPoliciesInPermissionSet
<a name="API_ListManagedPoliciesInPermissionSet"></a>

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

## Request Syntax
<a name="API_ListManagedPoliciesInPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_ListManagedPoliciesInPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ListManagedPoliciesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListManagedPoliciesInPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListManagedPoliciesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListManagedPoliciesInPermissionSet-request-MaxResults"></a>
The maximum number of results to display for the [PermissionSet](API_PermissionSet.md).  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListManagedPoliciesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListManagedPoliciesInPermissionSet-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [PermissionSetArn](#API_ListManagedPoliciesInPermissionSet_RequestSyntax) **   <a name="singlesignon-ListManagedPoliciesInPermissionSet-request-PermissionSetArn"></a>
The ARN of the [PermissionSet](API_PermissionSet.md) whose managed policies will be listed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Syntax
<a name="API_ListManagedPoliciesInPermissionSet_ResponseSyntax"></a>

```
{
   "AttachedManagedPolicies": [ 
      { 
         "Arn": "string",
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListManagedPoliciesInPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttachedManagedPolicies](#API_ListManagedPoliciesInPermissionSet_ResponseSyntax) **   <a name="singlesignon-ListManagedPoliciesInPermissionSet-response-AttachedManagedPolicies"></a>
An array of the [AttachedManagedPolicy](API_AttachedManagedPolicy.md) data type object.  
Type: Array of [AttachedManagedPolicy](API_AttachedManagedPolicy.md) objects

 ** [NextToken](#API_ListManagedPoliciesInPermissionSet_ResponseSyntax) **   <a name="singlesignon-ListManagedPoliciesInPermissionSet-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

## Errors
<a name="API_ListManagedPoliciesInPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListManagedPoliciesInPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListManagedPoliciesInPermissionSet) 

# ListPermissionSetProvisioningStatus
<a name="API_ListPermissionSetProvisioningStatus"></a>

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

## Request Syntax
<a name="API_ListPermissionSetProvisioningStatus_RequestSyntax"></a>

```
{
   "Filter": { 
      "Status": "string"
   },
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListPermissionSetProvisioningStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListPermissionSetProvisioningStatus_RequestSyntax) **   <a name="singlesignon-ListPermissionSetProvisioningStatus-request-Filter"></a>
Filters results based on the passed attribute value.  
Type: [OperationStatusFilter](API_OperationStatusFilter.md) object  
Required: No

 ** [InstanceArn](#API_ListPermissionSetProvisioningStatus_RequestSyntax) **   <a name="singlesignon-ListPermissionSetProvisioningStatus-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListPermissionSetProvisioningStatus_RequestSyntax) **   <a name="singlesignon-ListPermissionSetProvisioningStatus-request-MaxResults"></a>
The maximum number of results to display for the assignment.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListPermissionSetProvisioningStatus_RequestSyntax) **   <a name="singlesignon-ListPermissionSetProvisioningStatus-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListPermissionSetProvisioningStatus_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "PermissionSetsProvisioningStatus": [ 
      { 
         "CreatedDate": number,
         "RequestId": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPermissionSetProvisioningStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPermissionSetProvisioningStatus_ResponseSyntax) **   <a name="singlesignon-ListPermissionSetProvisioningStatus-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

 ** [PermissionSetsProvisioningStatus](#API_ListPermissionSetProvisioningStatus_ResponseSyntax) **   <a name="singlesignon-ListPermissionSetProvisioningStatus-response-PermissionSetsProvisioningStatus"></a>
The status object for the permission set provisioning operation.  
Type: Array of [PermissionSetProvisioningStatusMetadata](API_PermissionSetProvisioningStatusMetadata.md) objects

## Errors
<a name="API_ListPermissionSetProvisioningStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListPermissionSetProvisioningStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListPermissionSetProvisioningStatus) 

# ListPermissionSets
<a name="API_ListPermissionSets"></a>

Lists the [PermissionSet](API_PermissionSet.md)s in an IAM Identity Center instance.

## Request Syntax
<a name="API_ListPermissionSets_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListPermissionSets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ListPermissionSets_RequestSyntax) **   <a name="singlesignon-ListPermissionSets-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListPermissionSets_RequestSyntax) **   <a name="singlesignon-ListPermissionSets-request-MaxResults"></a>
The maximum number of results to display for the assignment.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListPermissionSets_RequestSyntax) **   <a name="singlesignon-ListPermissionSets-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListPermissionSets_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "PermissionSets": [ "string" ]
}
```

## Response Elements
<a name="API_ListPermissionSets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPermissionSets_ResponseSyntax) **   <a name="singlesignon-ListPermissionSets-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

 ** [PermissionSets](#API_ListPermissionSets_ResponseSyntax) **   <a name="singlesignon-ListPermissionSets-response-PermissionSets"></a>
Defines the level of access on an AWS account.  
Type: Array of strings  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}` 

## Errors
<a name="API_ListPermissionSets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListPermissionSets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListPermissionSets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListPermissionSets) 

# ListPermissionSetsProvisionedToAccount
<a name="API_ListPermissionSetsProvisionedToAccount"></a>

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

## Request Syntax
<a name="API_ListPermissionSetsProvisionedToAccount_RequestSyntax"></a>

```
{
   "AccountId": "string",
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ProvisioningStatus": "string"
}
```

## Request Parameters
<a name="API_ListPermissionSetsProvisionedToAccount_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AccountId](#API_ListPermissionSetsProvisionedToAccount_RequestSyntax) **   <a name="singlesignon-ListPermissionSetsProvisionedToAccount-request-AccountId"></a>
The identifier of the AWS account from which to list the assignments.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: Yes

 ** [InstanceArn](#API_ListPermissionSetsProvisionedToAccount_RequestSyntax) **   <a name="singlesignon-ListPermissionSetsProvisionedToAccount-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListPermissionSetsProvisionedToAccount_RequestSyntax) **   <a name="singlesignon-ListPermissionSetsProvisionedToAccount-request-MaxResults"></a>
The maximum number of results to display for the assignment.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListPermissionSetsProvisionedToAccount_RequestSyntax) **   <a name="singlesignon-ListPermissionSetsProvisionedToAccount-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [ProvisioningStatus](#API_ListPermissionSetsProvisionedToAccount_RequestSyntax) **   <a name="singlesignon-ListPermissionSetsProvisionedToAccount-request-ProvisioningStatus"></a>
The status object for the permission set provisioning operation.  
Type: String  
Valid Values: `LATEST_PERMISSION_SET_PROVISIONED | LATEST_PERMISSION_SET_NOT_PROVISIONED`   
Required: No

## Response Syntax
<a name="API_ListPermissionSetsProvisionedToAccount_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "PermissionSets": [ "string" ]
}
```

## Response Elements
<a name="API_ListPermissionSetsProvisionedToAccount_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPermissionSetsProvisionedToAccount_ResponseSyntax) **   <a name="singlesignon-ListPermissionSetsProvisionedToAccount-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

 ** [PermissionSets](#API_ListPermissionSetsProvisionedToAccount_ResponseSyntax) **   <a name="singlesignon-ListPermissionSetsProvisionedToAccount-response-PermissionSets"></a>
Defines the level of access that an AWS account has.  
Type: Array of strings  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}` 

## Errors
<a name="API_ListPermissionSetsProvisionedToAccount_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListPermissionSetsProvisionedToAccount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListPermissionSetsProvisionedToAccount) 

# ListRegions
<a name="API_ListRegions"></a>

Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status.

The following actions are related to `ListRegions`:
+  [ AddRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_AddRegion.html) 
+  [RemoveRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_RemoveRegion.html) 
+  [DescribeRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_DescribeRegion.html) 

## Request Syntax
<a name="API_ListRegions_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListRegions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ListRegions_RequestSyntax) **   <a name="singlesignon-ListRegions-request-InstanceArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center instance.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListRegions_RequestSyntax) **   <a name="singlesignon-ListRegions-request-MaxResults"></a>
The maximum number of results to return in a single call. Default is 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListRegions_RequestSyntax) **   <a name="singlesignon-ListRegions-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListRegions_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Regions": [ 
      { 
         "AddedDate": number,
         "IsPrimaryRegion": boolean,
         "RegionName": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRegions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRegions_ResponseSyntax) **   <a name="singlesignon-ListRegions-response-NextToken"></a>
The pagination token to be used in subsequent calls. If the value is null, then there are no more entries.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

 ** [Regions](#API_ListRegions_ResponseSyntax) **   <a name="singlesignon-ListRegions-response-Regions"></a>
The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.  
Type: Array of [RegionMetadata](API_RegionMetadata.md) objects

## Errors
<a name="API_ListRegions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListRegions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListRegions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListRegions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists the tags that are attached to a specified resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "NextToken": "string",
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="singlesignon-ListTagsForResource-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** [NextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="singlesignon-ListTagsForResource-request-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="singlesignon-ListTagsForResource-request-ResourceArn"></a>
The ARN of the resource with the tags to be listed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 2048.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="singlesignon-ListTagsForResource-response-NextToken"></a>
The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="singlesignon-ListTagsForResource-response-Tags"></a>
A set of key-value pairs that are used to manage the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 75 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListTagsForResource) 

# ListTrustedTokenIssuers
<a name="API_ListTrustedTokenIssuers"></a>

Lists all the trusted token issuers configured in an instance of IAM Identity Center.

## Request Syntax
<a name="API_ListTrustedTokenIssuers_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListTrustedTokenIssuers_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ListTrustedTokenIssuers_RequestSyntax) **   <a name="singlesignon-ListTrustedTokenIssuers-request-InstanceArn"></a>
Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want to list.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [MaxResults](#API_ListTrustedTokenIssuers_RequestSyntax) **   <a name="singlesignon-ListTrustedTokenIssuers-request-MaxResults"></a>
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the `NextToken` response element is returned with a value (not null). Include the specified value as the `NextToken` request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check `NextToken` after every operation to ensure that you receive all of the results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListTrustedTokenIssuers_RequestSyntax) **   <a name="singlesignon-ListTrustedTokenIssuers-request-NextToken"></a>
Specifies that you want to receive the next page of results. Valid only if you received a `NextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's `NextToken` response to request the next page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*`   
Required: No

## Response Syntax
<a name="API_ListTrustedTokenIssuers_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "TrustedTokenIssuers": [ 
      { 
         "Name": "string",
         "TrustedTokenIssuerArn": "string",
         "TrustedTokenIssuerType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTrustedTokenIssuers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTrustedTokenIssuers_ResponseSyntax) **   <a name="singlesignon-ListTrustedTokenIssuers-response-NextToken"></a>
If present, this value indicates that more output is available than is included in the current response. Use this value in the `NextToken` request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the `NextToken` response element comes back as `null`. This indicates that this is the last page of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `[-a-zA-Z0-9+=/_]*` 

 ** [TrustedTokenIssuers](#API_ListTrustedTokenIssuers_ResponseSyntax) **   <a name="singlesignon-ListTrustedTokenIssuers-response-TrustedTokenIssuers"></a>
An array list of the trusted token issuer configurations.  
Type: Array of [TrustedTokenIssuerMetadata](API_TrustedTokenIssuerMetadata.md) objects

## Errors
<a name="API_ListTrustedTokenIssuers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ListTrustedTokenIssuers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ListTrustedTokenIssuers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ListTrustedTokenIssuers) 

# ProvisionPermissionSet
<a name="API_ProvisionPermissionSet"></a>

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

## Request Syntax
<a name="API_ProvisionPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionSetArn": "string",
   "TargetId": "string",
   "TargetType": "string"
}
```

## Request Parameters
<a name="API_ProvisionPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_ProvisionPermissionSet_RequestSyntax) **   <a name="singlesignon-ProvisionPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_ProvisionPermissionSet_RequestSyntax) **   <a name="singlesignon-ProvisionPermissionSet-request-PermissionSetArn"></a>
The ARN of the permission set.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

 ** [TargetId](#API_ProvisionPermissionSet_RequestSyntax) **   <a name="singlesignon-ProvisionPermissionSet-request-TargetId"></a>
TargetID is an AWS account identifier, (For example, 123456789012).  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: No

 ** [TargetType](#API_ProvisionPermissionSet_RequestSyntax) **   <a name="singlesignon-ProvisionPermissionSet-request-TargetType"></a>
The entity type for which the assignment will be created.  
Type: String  
Valid Values: `AWS_ACCOUNT | ALL_PROVISIONED_ACCOUNTS`   
Required: Yes

## Response Syntax
<a name="API_ProvisionPermissionSet_ResponseSyntax"></a>

```
{
   "PermissionSetProvisioningStatus": { 
      "AccountId": "string",
      "CreatedDate": number,
      "FailureReason": "string",
      "PermissionSetArn": "string",
      "RequestId": "string",
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_ProvisionPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PermissionSetProvisioningStatus](#API_ProvisionPermissionSet_ResponseSyntax) **   <a name="singlesignon-ProvisionPermissionSet-response-PermissionSetProvisioningStatus"></a>
The status object for the permission set provisioning operation.  
Type: [PermissionSetProvisioningStatus](API_PermissionSetProvisioningStatus.md) object

## Errors
<a name="API_ProvisionPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_ProvisionPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/ProvisionPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/ProvisionPermissionSet) 

# PutApplicationAccessScope
<a name="API_PutApplicationAccessScope"></a>

Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.

## Request Syntax
<a name="API_PutApplicationAccessScope_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "AuthorizedTargets": [ "string" ],
   "Scope": "string"
}
```

## Request Parameters
<a name="API_PutApplicationAccessScope_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_PutApplicationAccessScope_RequestSyntax) **   <a name="singlesignon-PutApplicationAccessScope-request-ApplicationArn"></a>
Specifies the ARN of the application with the access scope with the targets to add or update.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [AuthorizedTargets](#API_PutApplicationAccessScope_RequestSyntax) **   <a name="singlesignon-PutApplicationAccessScope-request-AuthorizedTargets"></a>
Specifies an array list of ARNs that represent the authorized targets for this access scope.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::(\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}|:instance/(sso)?ins-[a-zA-Z0-9-.]{16})`   
Required: No

 ** [Scope](#API_PutApplicationAccessScope_RequestSyntax) **   <a name="singlesignon-PutApplicationAccessScope-request-Scope"></a>
Specifies the name of the access scope to be associated with the specified targets.  
Type: String  
Pattern: `([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}`   
Required: Yes

## Response Elements
<a name="API_PutApplicationAccessScope_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutApplicationAccessScope_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_PutApplicationAccessScope_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/PutApplicationAccessScope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/PutApplicationAccessScope) 

# PutApplicationAssignmentConfiguration
<a name="API_PutApplicationAssignmentConfiguration"></a>

Configure how users gain access to an application. If `AssignmentsRequired` is `true` (default value), users don’t have access to the application unless an assignment is created using the [CreateApplicationAssignment API](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html). If `false`, all users have access to the application. If an assignment is created using [CreateApplicationAssignment](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html)., the user retains access if `AssignmentsRequired` is set to `true`. 

## Request Syntax
<a name="API_PutApplicationAssignmentConfiguration_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "AssignmentRequired": boolean
}
```

## Request Parameters
<a name="API_PutApplicationAssignmentConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_PutApplicationAssignmentConfiguration_RequestSyntax) **   <a name="singlesignon-PutApplicationAssignmentConfiguration-request-ApplicationArn"></a>
Specifies the ARN of the application. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [AssignmentRequired](#API_PutApplicationAssignmentConfiguration_RequestSyntax) **   <a name="singlesignon-PutApplicationAssignmentConfiguration-request-AssignmentRequired"></a>
If `AssignmentsRequired` is `true` (default value), users don’t have access to the application unless an assignment is created using the [CreateApplicationAssignment API](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html). If `false`, all users have access to the application.   
Type: Boolean  
Required: Yes

## Response Elements
<a name="API_PutApplicationAssignmentConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutApplicationAssignmentConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_PutApplicationAssignmentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/PutApplicationAssignmentConfiguration) 

# PutApplicationAuthenticationMethod
<a name="API_PutApplicationAuthenticationMethod"></a>

Adds or updates an authentication method for an application.

## Request Syntax
<a name="API_PutApplicationAuthenticationMethod_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "AuthenticationMethod": { ... },
   "AuthenticationMethodType": "string"
}
```

## Request Parameters
<a name="API_PutApplicationAuthenticationMethod_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_PutApplicationAuthenticationMethod_RequestSyntax) **   <a name="singlesignon-PutApplicationAuthenticationMethod-request-ApplicationArn"></a>
Specifies the ARN of the application with the authentication method to add or update.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [AuthenticationMethod](#API_PutApplicationAuthenticationMethod_RequestSyntax) **   <a name="singlesignon-PutApplicationAuthenticationMethod-request-AuthenticationMethod"></a>
Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the `AuthenticationMethodType` parameter.  
Type: [AuthenticationMethod](API_AuthenticationMethod.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [AuthenticationMethodType](#API_PutApplicationAuthenticationMethod_RequestSyntax) **   <a name="singlesignon-PutApplicationAuthenticationMethod-request-AuthenticationMethodType"></a>
Specifies the type of the authentication method that you want to add or update.  
Type: String  
Valid Values: `IAM`   
Required: Yes

## Response Elements
<a name="API_PutApplicationAuthenticationMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutApplicationAuthenticationMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_PutApplicationAuthenticationMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/PutApplicationAuthenticationMethod) 

# PutApplicationGrant
<a name="API_PutApplicationGrant"></a>

Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see [SAML 2.0 and OAuth 2.0](https://docs.aws.amazon.com/singlesignon/latest/userguide/customermanagedapps-saml2-oauth2.html).

A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to AWS resources on behalf of users. The following elements are within these exchanges:
+  **Requester** - The application requesting access to AWS resources.
+  **Subject** - Typically the user that is requesting access to AWS resources.
+  **Grant** - Conceptually, a grant is authorization to access AWS resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
  +  **AuthorizationCode** - Allows an application to request authorization through a series of user-agent redirects.
  +  **JWT bearer ** - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see [RFC 6479](https://datatracker.ietf.org/doc/html/rfc6749).
  +  **Refresh token** - Enables application to request new access tokens to replace expiring or expired access tokens.
  +  **Exchange token** - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see [RFC 8693](https://datatracker.ietf.org/doc/html/rfc8693).
+  **Authorization server** - IAM Identity Center requests tokens.

User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see [RFC 6479](https://datatracker.ietf.org/doc/html/rfc6749).

**Use cases**
+ Connecting to custom applications.
+ Configuring an AWS service to make calls to another AWS services using JWT tokens.

## Request Syntax
<a name="API_PutApplicationGrant_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "Grant": { ... },
   "GrantType": "string"
}
```

## Request Parameters
<a name="API_PutApplicationGrant_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_PutApplicationGrant_RequestSyntax) **   <a name="singlesignon-PutApplicationGrant-request-ApplicationArn"></a>
Specifies the ARN of the application to update.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [Grant](#API_PutApplicationGrant_RequestSyntax) **   <a name="singlesignon-PutApplicationGrant-request-Grant"></a>
Specifies a structure that describes the grant to update.  
Type: [Grant](API_Grant.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [GrantType](#API_PutApplicationGrant_RequestSyntax) **   <a name="singlesignon-PutApplicationGrant-request-GrantType"></a>
Specifies the type of grant to update.  
Type: String  
Valid Values: `authorization_code | refresh_token | urn:ietf:params:oauth:grant-type:jwt-bearer | urn:ietf:params:oauth:grant-type:token-exchange`   
Required: Yes

## Response Elements
<a name="API_PutApplicationGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutApplicationGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_PutApplicationGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/PutApplicationGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/PutApplicationGrant) 

# PutApplicationSessionConfiguration
<a name="API_PutApplicationSessionConfiguration"></a>

Updates the session configuration for an application in IAM Identity Center.

The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported AWS managed application without having to remain signed in to an active session while the job runs.

## Request Syntax
<a name="API_PutApplicationSessionConfiguration_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "UserBackgroundSessionApplicationStatus": "string"
}
```

## Request Parameters
<a name="API_PutApplicationSessionConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_PutApplicationSessionConfiguration_RequestSyntax) **   <a name="singlesignon-PutApplicationSessionConfiguration-request-ApplicationArn"></a>
The Amazon Resource Name (ARN) of the application for which to update the session configuration.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [UserBackgroundSessionApplicationStatus](#API_PutApplicationSessionConfiguration_RequestSyntax) **   <a name="singlesignon-PutApplicationSessionConfiguration-request-UserBackgroundSessionApplicationStatus"></a>
The status of user background sessions for the application.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Elements
<a name="API_PutApplicationSessionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutApplicationSessionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_PutApplicationSessionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/PutApplicationSessionConfiguration) 

# PutInlinePolicyToPermissionSet
<a name="API_PutInlinePolicyToPermissionSet"></a>

Attaches an inline policy to a permission set.

**Note**  
If the permission set is already referenced by one or more account assignments, you will need to call ` ProvisionPermissionSet ` after this action to apply the corresponding IAM policy updates to all assigned accounts.

## Request Syntax
<a name="API_PutInlinePolicyToPermissionSet_RequestSyntax"></a>

```
{
   "InlinePolicy": "string",
   "InstanceArn": "string",
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_PutInlinePolicyToPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InlinePolicy](#API_PutInlinePolicyToPermissionSet_RequestSyntax) **   <a name="singlesignon-PutInlinePolicyToPermissionSet-request-InlinePolicy"></a>
The inline policy to attach to a [PermissionSet](API_PermissionSet.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+`   
Required: Yes

 ** [InstanceArn](#API_PutInlinePolicyToPermissionSet_RequestSyntax) **   <a name="singlesignon-PutInlinePolicyToPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_PutInlinePolicyToPermissionSet_RequestSyntax) **   <a name="singlesignon-PutInlinePolicyToPermissionSet-request-PermissionSetArn"></a>
The ARN of the permission set.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_PutInlinePolicyToPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutInlinePolicyToPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_PutInlinePolicyToPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/PutInlinePolicyToPermissionSet) 

# PutPermissionsBoundaryToPermissionSet
<a name="API_PutPermissionsBoundaryToPermissionSet"></a>

Attaches an AWS managed or customer managed policy to the specified [PermissionSet](API_PermissionSet.md) as a permissions boundary.

## Request Syntax
<a name="API_PutPermissionsBoundaryToPermissionSet_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "PermissionsBoundary": { 
      "CustomerManagedPolicyReference": { 
         "Name": "string",
         "Path": "string"
      },
      "ManagedPolicyArn": "string"
   },
   "PermissionSetArn": "string"
}
```

## Request Parameters
<a name="API_PutPermissionsBoundaryToPermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_PutPermissionsBoundaryToPermissionSet_RequestSyntax) **   <a name="singlesignon-PutPermissionsBoundaryToPermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionsBoundary](#API_PutPermissionsBoundaryToPermissionSet_RequestSyntax) **   <a name="singlesignon-PutPermissionsBoundaryToPermissionSet-request-PermissionsBoundary"></a>
The permissions boundary that you want to attach to a `PermissionSet`.  
Type: [PermissionsBoundary](API_PermissionsBoundary.md) object  
Required: Yes

 ** [PermissionSetArn](#API_PutPermissionsBoundaryToPermissionSet_RequestSyntax) **   <a name="singlesignon-PutPermissionsBoundaryToPermissionSet-request-PermissionSetArn"></a>
The ARN of the `PermissionSet`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

## Response Elements
<a name="API_PutPermissionsBoundaryToPermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutPermissionsBoundaryToPermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_PutPermissionsBoundaryToPermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/PutPermissionsBoundaryToPermissionSet) 

# RemoveRegion
<a name="API_RemoveRegion"></a>

Removes an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The request must be made from the primary Region. The target Region cannot be the primary Region, and no other add or remove Region workflows can be in progress.

The following actions are related to `RemoveRegion`:
+  [ AddRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_AddRegion.html) 
+  [DescribeRegion](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_DescribeRegion.html) 
+  [ListRegions](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListRegions.html) 

## Request Syntax
<a name="API_RemoveRegion_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "RegionName": "string"
}
```

## Request Parameters
<a name="API_RemoveRegion_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_RemoveRegion_RequestSyntax) **   <a name="singlesignon-RemoveRegion-request-InstanceArn"></a>
The Amazon Resource Name (ARN) of the IAM Identity Center instance.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [RegionName](#API_RemoveRegion_RequestSyntax) **   <a name="singlesignon-RemoveRegion-request-RegionName"></a>
The name of the AWS Region to remove from the IAM Identity Center instance. The Region name must be 1-32 characters long and follow the pattern of AWS Region names (for example, us-east-1). The primary Region cannot be removed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `([a-z]+-){2,3}\d`   
Required: Yes

## Response Syntax
<a name="API_RemoveRegion_ResponseSyntax"></a>

```
{
   "Status": "string"
}
```

## Response Elements
<a name="API_RemoveRegion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Status](#API_RemoveRegion_ResponseSyntax) **   <a name="singlesignon-RemoveRegion-response-Status"></a>
The status of the Region after the remove operation. The status is REMOVING when the asynchronous workflow is in progress. The Region record is deleted when the workflow completes.  
Type: String  
Valid Values: `ACTIVE | ADDING | REMOVING` 

## Errors
<a name="API_RemoveRegion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_RemoveRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/RemoveRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/RemoveRegion) 

# TagResource
<a name="API_TagResource"></a>

Associates a set of tags with a specified resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_TagResource_RequestSyntax) **   <a name="singlesignon-TagResource-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="singlesignon-TagResource-request-ResourceArn"></a>
The ARN of the resource with the tags to be listed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 2048.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))`   
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="singlesignon-TagResource-request-Tags"></a>
A set of key-value pairs that are used to manage the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 75 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Indicates that the principal has crossed the permitted number of resources that can be created.  
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Disassociates a set of tags from a specified resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "InstanceArn": "string",
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceArn](#API_UntagResource_RequestSyntax) **   <a name="singlesignon-UntagResource-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: No

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="singlesignon-UntagResource-request-ResourceArn"></a>
The ARN of the resource with the tags to be listed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 2048.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))`   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="singlesignon-UntagResource-request-TagKeys"></a>
The keys of tags that are attached to the resource.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 75 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/UntagResource) 

# UpdateApplication
<a name="API_UpdateApplication"></a>

Updates application properties. 

## Request Syntax
<a name="API_UpdateApplication_RequestSyntax"></a>

```
{
   "ApplicationArn": "string",
   "Description": "string",
   "Name": "string",
   "PortalOptions": { 
      "SignInOptions": { 
         "ApplicationUrl": "string",
         "Origin": "string"
      }
   },
   "Status": "string"
}
```

## Request Parameters
<a name="API_UpdateApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ApplicationArn](#API_UpdateApplication_RequestSyntax) **   <a name="singlesignon-UpdateApplication-request-ApplicationArn"></a>
Specifies the ARN of the application. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}`   
Required: Yes

 ** [Description](#API_UpdateApplication_RequestSyntax) **   <a name="singlesignon-UpdateApplication-request-Description"></a>
The description of the [Application](API_Application.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Name](#API_UpdateApplication_RequestSyntax) **   <a name="singlesignon-UpdateApplication-request-Name"></a>
Specifies the updated name for the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\S\s]*`   
Required: No

 ** [PortalOptions](#API_UpdateApplication_RequestSyntax) **   <a name="singlesignon-UpdateApplication-request-PortalOptions"></a>
A structure that describes the options for the portal associated with an application.  
Type: [UpdateApplicationPortalOptions](API_UpdateApplicationPortalOptions.md) object  
Required: No

 ** [Status](#API_UpdateApplication_RequestSyntax) **   <a name="singlesignon-UpdateApplication-request-Status"></a>
Specifies whether the application is enabled or disabled.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Elements
<a name="API_UpdateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_UpdateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/UpdateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/UpdateApplication) 

# UpdateInstance
<a name="API_UpdateInstance"></a>

Update the details for the instance of IAM Identity Center that is owned by the AWS account.

## Request Syntax
<a name="API_UpdateInstance_RequestSyntax"></a>

```
{
   "EncryptionConfiguration": { 
      "KeyType": "string",
      "KmsKeyArn": "string"
   },
   "InstanceArn": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EncryptionConfiguration](#API_UpdateInstance_RequestSyntax) **   <a name="singlesignon-UpdateInstance-request-EncryptionConfiguration"></a>
Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys or AWS owned KMS keys for encrypting your instance data.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [InstanceArn](#API_UpdateInstance_RequestSyntax) **   <a name="singlesignon-UpdateInstance-request-InstanceArn"></a>
The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [Name](#API_UpdateInstance_RequestSyntax) **   <a name="singlesignon-UpdateInstance-request-Name"></a>
Updates the instance name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `[\w+=,.@-]+`   
Required: No

## Response Elements
<a name="API_UpdateInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_UpdateInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/UpdateInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/UpdateInstance) 

# UpdateInstanceAccessControlAttributeConfiguration
<a name="API_UpdateInstanceAccessControlAttributeConfiguration"></a>

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see [Attribute-Based Access Control](/singlesignon/latest/userguide/abac.html) in the *IAM Identity Center User Guide*.

## Request Syntax
<a name="API_UpdateInstanceAccessControlAttributeConfiguration_RequestSyntax"></a>

```
{
   "InstanceAccessControlAttributeConfiguration": { 
      "AccessControlAttributes": [ 
         { 
            "Key": "string",
            "Value": { 
               "Source": [ "string" ]
            }
         }
      ]
   },
   "InstanceArn": "string"
}
```

## Request Parameters
<a name="API_UpdateInstanceAccessControlAttributeConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [InstanceAccessControlAttributeConfiguration](#API_UpdateInstanceAccessControlAttributeConfiguration_RequestSyntax) **   <a name="singlesignon-UpdateInstanceAccessControlAttributeConfiguration-request-InstanceAccessControlAttributeConfiguration"></a>
Updates the attributes for your ABAC configuration.  
Type: [InstanceAccessControlAttributeConfiguration](API_InstanceAccessControlAttributeConfiguration.md) object  
Required: Yes

 ** [InstanceArn](#API_UpdateInstanceAccessControlAttributeConfiguration_RequestSyntax) **   <a name="singlesignon-UpdateInstanceAccessControlAttributeConfiguration-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

## Response Elements
<a name="API_UpdateInstanceAccessControlAttributeConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateInstanceAccessControlAttributeConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_UpdateInstanceAccessControlAttributeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/UpdateInstanceAccessControlAttributeConfiguration) 

# UpdatePermissionSet
<a name="API_UpdatePermissionSet"></a>

Updates an existing permission set.

## Request Syntax
<a name="API_UpdatePermissionSet_RequestSyntax"></a>

```
{
   "Description": "string",
   "InstanceArn": "string",
   "PermissionSetArn": "string",
   "RelayState": "string",
   "SessionDuration": "string"
}
```

## Request Parameters
<a name="API_UpdatePermissionSet_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_UpdatePermissionSet_RequestSyntax) **   <a name="singlesignon-UpdatePermissionSet-request-Description"></a>
The description of the [PermissionSet](API_PermissionSet.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 700.  
Pattern: `[\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]*`   
Required: No

 ** [InstanceArn](#API_UpdatePermissionSet_RequestSyntax) **   <a name="singlesignon-UpdatePermissionSet-request-InstanceArn"></a>
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces](/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}`   
Required: Yes

 ** [PermissionSetArn](#API_UpdatePermissionSet_RequestSyntax) **   <a name="singlesignon-UpdatePermissionSet-request-PermissionSetArn"></a>
The ARN of the permission set.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}`   
Required: Yes

 ** [RelayState](#API_UpdatePermissionSet_RequestSyntax) **   <a name="singlesignon-UpdatePermissionSet-request-RelayState"></a>
Used to redirect users within the application during the federation authentication process.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Pattern: `[a-zA-Z0-9&$@#\\\/%?=~\-_'"|!:,.;*+\[\]\ \(\)\{\}]+`   
Required: No

 ** [SessionDuration](#API_UpdatePermissionSet_RequestSyntax) **   <a name="singlesignon-UpdatePermissionSet-request-SessionDuration"></a>
The length of time that the application user sessions are valid for in the ISO-8601 standard.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?`   
Required: No

## Response Elements
<a name="API_UpdatePermissionSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdatePermissionSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_UpdatePermissionSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/UpdatePermissionSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/UpdatePermissionSet) 

# UpdateTrustedTokenIssuer
<a name="API_UpdateTrustedTokenIssuer"></a>

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.

**Note**  
Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.

## Request Syntax
<a name="API_UpdateTrustedTokenIssuer_RequestSyntax"></a>

```
{
   "Name": "string",
   "TrustedTokenIssuerArn": "string",
   "TrustedTokenIssuerConfiguration": { ... }
}
```

## Request Parameters
<a name="API_UpdateTrustedTokenIssuer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_UpdateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-UpdateTrustedTokenIssuer-request-Name"></a>
Specifies the updated name to be applied to the trusted token issuer configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\w+=,.@-]+`   
Required: No

 ** [TrustedTokenIssuerArn](#API_UpdateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-UpdateTrustedTokenIssuer-request-TrustedTokenIssuerArn"></a>
Specifies the ARN of the trusted token issuer configuration that you want to update.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 1224.  
Pattern: `arn:aws(-[a-z]{1,5}){0,3}:sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [TrustedTokenIssuerConfiguration](#API_UpdateTrustedTokenIssuer_RequestSyntax) **   <a name="singlesignon-UpdateTrustedTokenIssuer-request-TrustedTokenIssuerConfiguration"></a>
Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.  
Type: [TrustedTokenIssuerUpdateConfiguration](API_TrustedTokenIssuerUpdateConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Elements
<a name="API_UpdateTrustedTokenIssuer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateTrustedTokenIssuer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.    
 ** Reason **   
The reason for the access denied exception.
HTTP Status Code: 400

 ** ConflictException **   
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.  
HTTP Status Code: 400

 ** InternalServerException **   
The request processing has failed because of an unknown error, exception, or failure with an internal server.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Indicates that a requested resource is not found.    
 ** Reason **   
The reason for the resource not found exception.
HTTP Status Code: 400

 ** ThrottlingException **   
Indicates that the principal has crossed the throttling limits of the API operations.    
 ** Reason **   
The reason for the throttling exception.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because it contains a syntax error.    
 ** Reason **   
The reason for the validation exception.
HTTP Status Code: 400

## See Also
<a name="API_UpdateTrustedTokenIssuer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sso-admin-2020-07-20/UpdateTrustedTokenIssuer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sso-admin-2020-07-20/UpdateTrustedTokenIssuer)