AttachCustomerManagedPolicyReferenceToPermissionSet

$result = $client->attachCustomerManagedPolicyReferenceToPermissionSet([/* ... */]);
$promise = $client->attachCustomerManagedPolicyReferenceToPermissionSetAsync([/* ... */]);

Attaches the specified customer managed policy to the specified PermissionSet.

Parameter Syntax

$result = $client->attachCustomerManagedPolicyReferenceToPermissionSet([
    'CustomerManagedPolicyReference' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
        'Path' => '<string>',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

AttachManagedPolicyToPermissionSet

$result = $client->attachManagedPolicyToPermissionSet([/* ... */]);
$promise = $client->attachManagedPolicyToPermissionSetAsync([/* ... */]);

Attaches an Amazon Web Services managed policy ARN to a permission set.

Parameter Syntax

$result = $client->attachManagedPolicyToPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'ManagedPolicyArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

CreateAccountAssignment

$result = $client->createAccountAssignment([/* ... */]);
$promise = $client->createAccountAssignmentAsync([/* ... */]);

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.

Parameter Syntax

$result = $client->createAccountAssignment([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
    'PrincipalId' => '<string>', // REQUIRED
    'PrincipalType' => 'USER|GROUP', // REQUIRED
    'TargetId' => '<string>', // REQUIRED
    'TargetType' => 'AWS_ACCOUNT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountAssignmentCreationStatus' => [
        'CreatedDate' => <DateTime>,
        'FailureReason' => '<string>',
        'PermissionSetArn' => '<string>',
        'PrincipalId' => '<string>',
        'PrincipalType' => 'USER|GROUP',
        'RequestId' => '<string>',
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
        'TargetId' => '<string>',
        'TargetType' => 'AWS_ACCOUNT',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createApplication([
    'ApplicationProviderArn' => '<string>', // REQUIRED
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'InstanceArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'PortalOptions' => [
        'SignInOptions' => [
            'ApplicationUrl' => '<string>',
            'Origin' => 'IDENTITY_CENTER|APPLICATION', // REQUIRED
        ],
        'Visibility' => 'ENABLED|DISABLED',
    ],
    'Status' => 'ENABLED|DISABLED',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ApplicationArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

CreateApplicationAssignment

$result = $client->createApplicationAssignment([/* ... */]);
$promise = $client->createApplicationAssignmentAsync([/* ... */]);

Grant application access to a user or group.

Parameter Syntax

$result = $client->createApplicationAssignment([
    'ApplicationArn' => '<string>', // REQUIRED
    'PrincipalId' => '<string>', // REQUIRED
    'PrincipalType' => 'USER|GROUP', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

CreateInstance

$result = $client->createInstance([/* ... */]);
$promise = $client->createInstanceAsync([/* ... */]);

Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services 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.

Parameter Syntax

$result = $client->createInstance([
    'ClientToken' => '<string>',
    'Name' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'InstanceArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

CreateInstanceAccessControlAttributeConfiguration

$result = $client->createInstanceAccessControlAttributeConfiguration([/* ... */]);
$promise = $client->createInstanceAccessControlAttributeConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createInstanceAccessControlAttributeConfiguration([
    'InstanceAccessControlAttributeConfiguration' => [ // REQUIRED
        'AccessControlAttributes' => [ // REQUIRED
            [
                'Key' => '<string>', // REQUIRED
                'Value' => [ // REQUIRED
                    'Source' => ['<string>', ...], // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'InstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

CreatePermissionSet

$result = $client->createPermissionSet([/* ... */]);
$promise = $client->createPermissionSetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createPermissionSet([
    'Description' => '<string>',
    'InstanceArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RelayState' => '<string>',
    'SessionDuration' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'PermissionSet' => [
        'CreatedDate' => <DateTime>,
        'Description' => '<string>',
        'Name' => '<string>',
        'PermissionSetArn' => '<string>',
        'RelayState' => '<string>',
        'SessionDuration' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

CreateTrustedTokenIssuer

$result = $client->createTrustedTokenIssuer([/* ... */]);
$promise = $client->createTrustedTokenIssuerAsync([/* ... */]);

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 Amazon Web Services.

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.

Parameter Syntax

$result = $client->createTrustedTokenIssuer([
    'ClientToken' => '<string>',
    'InstanceArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrustedTokenIssuerConfiguration' => [ // REQUIRED
        'OidcJwtConfiguration' => [
            'ClaimAttributePath' => '<string>', // REQUIRED
            'IdentityStoreAttributePath' => '<string>', // REQUIRED
            'IssuerUrl' => '<string>', // REQUIRED
            'JwksRetrievalOption' => 'OPEN_ID_DISCOVERY', // REQUIRED
        ],
    ],
    'TrustedTokenIssuerType' => 'OIDC_JWT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TrustedTokenIssuerArn' => '<string>',
]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteAccountAssignment

$result = $client->deleteAccountAssignment([/* ... */]);
$promise = $client->deleteAccountAssignmentAsync([/* ... */]);

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.

Parameter Syntax

$result = $client->deleteAccountAssignment([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
    'PrincipalId' => '<string>', // REQUIRED
    'PrincipalType' => 'USER|GROUP', // REQUIRED
    'TargetId' => '<string>', // REQUIRED
    'TargetType' => 'AWS_ACCOUNT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountAssignmentDeletionStatus' => [
        'CreatedDate' => <DateTime>,
        'FailureReason' => '<string>',
        'PermissionSetArn' => '<string>',
        'PrincipalId' => '<string>',
        'PrincipalType' => 'USER|GROUP',
        'RequestId' => '<string>',
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
        'TargetId' => '<string>',
        'TargetType' => 'AWS_ACCOUNT',
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteApplication([
    'ApplicationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteApplicationAccessScope

$result = $client->deleteApplicationAccessScope([/* ... */]);
$promise = $client->deleteApplicationAccessScopeAsync([/* ... */]);

Deletes an IAM Identity Center access scope from an application.

Parameter Syntax

$result = $client->deleteApplicationAccessScope([
    'ApplicationArn' => '<string>', // REQUIRED
    'Scope' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteApplicationAssignment

$result = $client->deleteApplicationAssignment([/* ... */]);
$promise = $client->deleteApplicationAssignmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteApplicationAssignment([
    'ApplicationArn' => '<string>', // REQUIRED
    'PrincipalId' => '<string>', // REQUIRED
    'PrincipalType' => 'USER|GROUP', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteApplicationAuthenticationMethod

$result = $client->deleteApplicationAuthenticationMethod([/* ... */]);
$promise = $client->deleteApplicationAuthenticationMethodAsync([/* ... */]);

Deletes an authentication method from an application.

Parameter Syntax

$result = $client->deleteApplicationAuthenticationMethod([
    'ApplicationArn' => '<string>', // REQUIRED
    'AuthenticationMethodType' => 'IAM', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteApplicationGrant

$result = $client->deleteApplicationGrant([/* ... */]);
$promise = $client->deleteApplicationGrantAsync([/* ... */]);

Deletes a grant from an application.

Parameter Syntax

$result = $client->deleteApplicationGrant([
    'ApplicationArn' => '<string>', // REQUIRED
    'GrantType' => 'authorization_code|refresh_token|urn:ietf:params:oauth:grant-type:jwt-bearer|urn:ietf:params:oauth:grant-type:token-exchange', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteInlinePolicyFromPermissionSet

$result = $client->deleteInlinePolicyFromPermissionSet([/* ... */]);
$promise = $client->deleteInlinePolicyFromPermissionSetAsync([/* ... */]);

Deletes the inline policy from a specified permission set.

Parameter Syntax

$result = $client->deleteInlinePolicyFromPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteInstance

$result = $client->deleteInstance([/* ... */]);
$promise = $client->deleteInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteInstance([
    'InstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteInstanceAccessControlAttributeConfiguration

$result = $client->deleteInstanceAccessControlAttributeConfiguration([/* ... */]);
$promise = $client->deleteInstanceAccessControlAttributeConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteInstanceAccessControlAttributeConfiguration([
    'InstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeletePermissionSet

$result = $client->deletePermissionSet([/* ... */]);
$promise = $client->deletePermissionSetAsync([/* ... */]);

Deletes the specified permission set.

Parameter Syntax

$result = $client->deletePermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeletePermissionsBoundaryFromPermissionSet

$result = $client->deletePermissionsBoundaryFromPermissionSet([/* ... */]);
$promise = $client->deletePermissionsBoundaryFromPermissionSetAsync([/* ... */]);

Deletes the permissions boundary from a specified PermissionSet.

Parameter Syntax

$result = $client->deletePermissionsBoundaryFromPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DeleteTrustedTokenIssuer

$result = $client->deleteTrustedTokenIssuer([/* ... */]);
$promise = $client->deleteTrustedTokenIssuerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteTrustedTokenIssuer([
    'TrustedTokenIssuerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DescribeAccountAssignmentCreationStatus

$result = $client->describeAccountAssignmentCreationStatus([/* ... */]);
$promise = $client->describeAccountAssignmentCreationStatusAsync([/* ... */]);

Describes the status of the assignment creation request.

Parameter Syntax

$result = $client->describeAccountAssignmentCreationStatus([
    'AccountAssignmentCreationRequestId' => '<string>', // REQUIRED
    'InstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountAssignmentCreationStatus' => [
        'CreatedDate' => <DateTime>,
        'FailureReason' => '<string>',
        'PermissionSetArn' => '<string>',
        'PrincipalId' => '<string>',
        'PrincipalType' => 'USER|GROUP',
        'RequestId' => '<string>',
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
        'TargetId' => '<string>',
        'TargetType' => 'AWS_ACCOUNT',
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribeAccountAssignmentDeletionStatus

$result = $client->describeAccountAssignmentDeletionStatus([/* ... */]);
$promise = $client->describeAccountAssignmentDeletionStatusAsync([/* ... */]);

Describes the status of the assignment deletion request.

Parameter Syntax

$result = $client->describeAccountAssignmentDeletionStatus([
    'AccountAssignmentDeletionRequestId' => '<string>', // REQUIRED
    'InstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountAssignmentDeletionStatus' => [
        'CreatedDate' => <DateTime>,
        'FailureReason' => '<string>',
        'PermissionSetArn' => '<string>',
        'PrincipalId' => '<string>',
        'PrincipalType' => 'USER|GROUP',
        'RequestId' => '<string>',
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
        'TargetId' => '<string>',
        'TargetType' => 'AWS_ACCOUNT',
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribeApplication

$result = $client->describeApplication([/* ... */]);
$promise = $client->describeApplicationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeApplication([
    'ApplicationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationAccount' => '<string>',
    'ApplicationArn' => '<string>',
    'ApplicationProviderArn' => '<string>',
    'CreatedDate' => <DateTime>,
    'Description' => '<string>',
    'InstanceArn' => '<string>',
    'Name' => '<string>',
    'PortalOptions' => [
        'SignInOptions' => [
            'ApplicationUrl' => '<string>',
            'Origin' => 'IDENTITY_CENTER|APPLICATION',
        ],
        'Visibility' => 'ENABLED|DISABLED',
    ],
    'Status' => 'ENABLED|DISABLED',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribeApplicationAssignment

$result = $client->describeApplicationAssignment([/* ... */]);
$promise = $client->describeApplicationAssignmentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeApplicationAssignment([
    'ApplicationArn' => '<string>', // REQUIRED
    'PrincipalId' => '<string>', // REQUIRED
    'PrincipalType' => 'USER|GROUP', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationArn' => '<string>',
    'PrincipalId' => '<string>',
    'PrincipalType' => 'USER|GROUP',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribeApplicationProvider

$result = $client->describeApplicationProvider([/* ... */]);
$promise = $client->describeApplicationProviderAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeApplicationProvider([
    'ApplicationProviderArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationProviderArn' => '<string>',
    'DisplayData' => [
        'Description' => '<string>',
        'DisplayName' => '<string>',
        'IconUrl' => '<string>',
    ],
    'FederationProtocol' => 'SAML|OAUTH',
    'ResourceServerConfig' => [
        'Scopes' => [
            '<ResourceServerScope>' => [
                'DetailedTitle' => '<string>',
                'LongDescription' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribeInstance

$result = $client->describeInstance([/* ... */]);
$promise = $client->describeInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeInstance([
    'InstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedDate' => <DateTime>,
    'IdentityStoreId' => '<string>',
    'InstanceArn' => '<string>',
    'Name' => '<string>',
    'OwnerAccountId' => '<string>',
    'Status' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|ACTIVE',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribeInstanceAccessControlAttributeConfiguration

$result = $client->describeInstanceAccessControlAttributeConfiguration([/* ... */]);
$promise = $client->describeInstanceAccessControlAttributeConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeInstanceAccessControlAttributeConfiguration([
    'InstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InstanceAccessControlAttributeConfiguration' => [
        'AccessControlAttributes' => [
            [
                'Key' => '<string>',
                'Value' => [
                    'Source' => ['<string>', ...],
                ],
            ],
            // ...
        ],
    ],
    'Status' => 'ENABLED|CREATION_IN_PROGRESS|CREATION_FAILED',
    'StatusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribePermissionSet

$result = $client->describePermissionSet([/* ... */]);
$promise = $client->describePermissionSetAsync([/* ... */]);

Gets the details of the permission set.

Parameter Syntax

$result = $client->describePermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PermissionSet' => [
        'CreatedDate' => <DateTime>,
        'Description' => '<string>',
        'Name' => '<string>',
        'PermissionSetArn' => '<string>',
        'RelayState' => '<string>',
        'SessionDuration' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribePermissionSetProvisioningStatus

$result = $client->describePermissionSetProvisioningStatus([/* ... */]);
$promise = $client->describePermissionSetProvisioningStatusAsync([/* ... */]);

Describes the status for the given permission set provisioning request.

Parameter Syntax

$result = $client->describePermissionSetProvisioningStatus([
    'InstanceArn' => '<string>', // REQUIRED
    'ProvisionPermissionSetRequestId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PermissionSetProvisioningStatus' => [
        'AccountId' => '<string>',
        'CreatedDate' => <DateTime>,
        'FailureReason' => '<string>',
        'PermissionSetArn' => '<string>',
        'RequestId' => '<string>',
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DescribeTrustedTokenIssuer

$result = $client->describeTrustedTokenIssuer([/* ... */]);
$promise = $client->describeTrustedTokenIssuerAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeTrustedTokenIssuer([
    'TrustedTokenIssuerArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Name' => '<string>',
    'TrustedTokenIssuerArn' => '<string>',
    'TrustedTokenIssuerConfiguration' => [
        'OidcJwtConfiguration' => [
            'ClaimAttributePath' => '<string>',
            'IdentityStoreAttributePath' => '<string>',
            'IssuerUrl' => '<string>',
            'JwksRetrievalOption' => 'OPEN_ID_DISCOVERY',
        ],
    ],
    'TrustedTokenIssuerType' => 'OIDC_JWT',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

DetachCustomerManagedPolicyReferenceFromPermissionSet

$result = $client->detachCustomerManagedPolicyReferenceFromPermissionSet([/* ... */]);
$promise = $client->detachCustomerManagedPolicyReferenceFromPermissionSetAsync([/* ... */]);

Detaches the specified customer managed policy from the specified PermissionSet.

Parameter Syntax

$result = $client->detachCustomerManagedPolicyReferenceFromPermissionSet([
    'CustomerManagedPolicyReference' => [ // REQUIRED
        'Name' => '<string>', // REQUIRED
        'Path' => '<string>',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

DetachManagedPolicyFromPermissionSet

$result = $client->detachManagedPolicyFromPermissionSet([/* ... */]);
$promise = $client->detachManagedPolicyFromPermissionSetAsync([/* ... */]);

Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.

Parameter Syntax

$result = $client->detachManagedPolicyFromPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'ManagedPolicyArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

GetApplicationAccessScope

$result = $client->getApplicationAccessScope([/* ... */]);
$promise = $client->getApplicationAccessScopeAsync([/* ... */]);

Retrieves the authorized targets for an IAM Identity Center access scope for an application.

Parameter Syntax

$result = $client->getApplicationAccessScope([
    'ApplicationArn' => '<string>', // REQUIRED
    'Scope' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuthorizedTargets' => ['<string>', ...],
    'Scope' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

GetApplicationAssignmentConfiguration

$result = $client->getApplicationAssignmentConfiguration([/* ... */]);
$promise = $client->getApplicationAssignmentConfigurationAsync([/* ... */]);

Retrieves the configuration of PutApplicationAssignmentConfiguration.

Parameter Syntax

$result = $client->getApplicationAssignmentConfiguration([
    'ApplicationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AssignmentRequired' => true || false,
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

GetApplicationAuthenticationMethod

$result = $client->getApplicationAuthenticationMethod([/* ... */]);
$promise = $client->getApplicationAuthenticationMethodAsync([/* ... */]);

Retrieves details about an authentication method used by an application.

Parameter Syntax

$result = $client->getApplicationAuthenticationMethod([
    'ApplicationArn' => '<string>', // REQUIRED
    'AuthenticationMethodType' => 'IAM', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuthenticationMethod' => [
        'Iam' => [
            'ActorPolicy' => [
            ],
        ],
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

GetApplicationGrant

$result = $client->getApplicationGrant([/* ... */]);
$promise = $client->getApplicationGrantAsync([/* ... */]);

Retrieves details about an application grant.

Parameter Syntax

$result = $client->getApplicationGrant([
    'ApplicationArn' => '<string>', // REQUIRED
    'GrantType' => 'authorization_code|refresh_token|urn:ietf:params:oauth:grant-type:jwt-bearer|urn:ietf:params:oauth:grant-type:token-exchange', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Grant' => [
        'AuthorizationCode' => [
            'RedirectUris' => ['<string>', ...],
        ],
        'JwtBearer' => [
            'AuthorizedTokenIssuers' => [
                [
                    'AuthorizedAudiences' => ['<string>', ...],
                    'TrustedTokenIssuerArn' => '<string>',
                ],
                // ...
            ],
        ],
        'RefreshToken' => [
        ],
        'TokenExchange' => [
        ],
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

GetInlinePolicyForPermissionSet

$result = $client->getInlinePolicyForPermissionSet([/* ... */]);
$promise = $client->getInlinePolicyForPermissionSetAsync([/* ... */]);

Obtains the inline policy assigned to the permission set.

Parameter Syntax

$result = $client->getInlinePolicyForPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InlinePolicy' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

GetPermissionsBoundaryForPermissionSet

$result = $client->getPermissionsBoundaryForPermissionSet([/* ... */]);
$promise = $client->getPermissionsBoundaryForPermissionSetAsync([/* ... */]);

Obtains the permissions boundary for a specified PermissionSet.

Parameter Syntax

$result = $client->getPermissionsBoundaryForPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PermissionsBoundary' => [
        'CustomerManagedPolicyReference' => [
            'Name' => '<string>',
            'Path' => '<string>',
        ],
        'ManagedPolicyArn' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListAccountAssignmentCreationStatus

$result = $client->listAccountAssignmentCreationStatus([/* ... */]);
$promise = $client->listAccountAssignmentCreationStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAccountAssignmentCreationStatus([
    'Filter' => [
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AccountAssignmentsCreationStatus' => [
        [
            'CreatedDate' => <DateTime>,
            'RequestId' => '<string>',
            'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListAccountAssignmentDeletionStatus

$result = $client->listAccountAssignmentDeletionStatus([/* ... */]);
$promise = $client->listAccountAssignmentDeletionStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAccountAssignmentDeletionStatus([
    'Filter' => [
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AccountAssignmentsDeletionStatus' => [
        [
            'CreatedDate' => <DateTime>,
            'RequestId' => '<string>',
            'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListAccountAssignments

$result = $client->listAccountAssignments([/* ... */]);
$promise = $client->listAccountAssignmentsAsync([/* ... */]);

Lists the assignee of the specified Amazon Web Services account with the specified permission set.

Parameter Syntax

$result = $client->listAccountAssignments([
    'AccountId' => '<string>', // REQUIRED
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountAssignments' => [
        [
            'AccountId' => '<string>',
            'PermissionSetArn' => '<string>',
            'PrincipalId' => '<string>',
            'PrincipalType' => 'USER|GROUP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListAccountAssignmentsForPrincipal

$result = $client->listAccountAssignmentsForPrincipal([/* ... */]);
$promise = $client->listAccountAssignmentsForPrincipalAsync([/* ... */]);

Retrieves a list of the IAM Identity Center associated Amazon Web Services 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.

Parameter Syntax

$result = $client->listAccountAssignmentsForPrincipal([
    'Filter' => [
        'AccountId' => '<string>',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PrincipalId' => '<string>', // REQUIRED
    'PrincipalType' => 'USER|GROUP', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountAssignments' => [
        [
            'AccountId' => '<string>',
            'PermissionSetArn' => '<string>',
            'PrincipalId' => '<string>',
            'PrincipalType' => 'USER|GROUP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListAccountsForProvisionedPermissionSet

$result = $client->listAccountsForProvisionedPermissionSet([/* ... */]);
$promise = $client->listAccountsForProvisionedPermissionSetAsync([/* ... */]);

Lists all the Amazon Web Services accounts where the specified permission set is provisioned.

Parameter Syntax

$result = $client->listAccountsForProvisionedPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PermissionSetArn' => '<string>', // REQUIRED
    'ProvisioningStatus' => 'LATEST_PERMISSION_SET_PROVISIONED|LATEST_PERMISSION_SET_NOT_PROVISIONED',
]);

Parameter Details

Result Syntax

[
    'AccountIds' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListApplicationAccessScopes

$result = $client->listApplicationAccessScopes([/* ... */]);
$promise = $client->listApplicationAccessScopesAsync([/* ... */]);

Lists the access scopes and authorized targets associated with an application.

Parameter Syntax

$result = $client->listApplicationAccessScopes([
    'ApplicationArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Scopes' => [
        [
            'AuthorizedTargets' => ['<string>', ...],
            'Scope' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListApplicationAssignments

$result = $client->listApplicationAssignments([/* ... */]);
$promise = $client->listApplicationAssignmentsAsync([/* ... */]);

Lists Amazon Web Services account users that are assigned to an application.

Parameter Syntax

$result = $client->listApplicationAssignments([
    'ApplicationArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationAssignments' => [
        [
            'ApplicationArn' => '<string>',
            'PrincipalId' => '<string>',
            'PrincipalType' => 'USER|GROUP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListApplicationAssignmentsForPrincipal

$result = $client->listApplicationAssignmentsForPrincipal([/* ... */]);
$promise = $client->listApplicationAssignmentsForPrincipalAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listApplicationAssignmentsForPrincipal([
    'Filter' => [
        'ApplicationArn' => '<string>',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PrincipalId' => '<string>', // REQUIRED
    'PrincipalType' => 'USER|GROUP', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ApplicationAssignments' => [
        [
            'ApplicationArn' => '<string>',
            'PrincipalId' => '<string>',
            'PrincipalType' => 'USER|GROUP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListApplicationAuthenticationMethods

$result = $client->listApplicationAuthenticationMethods([/* ... */]);
$promise = $client->listApplicationAuthenticationMethodsAsync([/* ... */]);

Lists all of the authentication methods supported by the specified application.

Parameter Syntax

$result = $client->listApplicationAuthenticationMethods([
    'ApplicationArn' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AuthenticationMethods' => [
        [
            'AuthenticationMethod' => [
                'Iam' => [
                    'ActorPolicy' => [
                    ],
                ],
            ],
            'AuthenticationMethodType' => 'IAM',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListApplicationGrants

$result = $client->listApplicationGrants([/* ... */]);
$promise = $client->listApplicationGrantsAsync([/* ... */]);

List the grants associated with an application.

Parameter Syntax

$result = $client->listApplicationGrants([
    'ApplicationArn' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Grants' => [
        [
            'Grant' => [
                'AuthorizationCode' => [
                    'RedirectUris' => ['<string>', ...],
                ],
                'JwtBearer' => [
                    'AuthorizedTokenIssuers' => [
                        [
                            'AuthorizedAudiences' => ['<string>', ...],
                            'TrustedTokenIssuerArn' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'RefreshToken' => [
                ],
                'TokenExchange' => [
                ],
            ],
            'GrantType' => 'authorization_code|refresh_token|urn:ietf:params:oauth:grant-type:jwt-bearer|urn:ietf:params:oauth:grant-type:token-exchange',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListApplicationProviders

$result = $client->listApplicationProviders([/* ... */]);
$promise = $client->listApplicationProvidersAsync([/* ... */]);

Lists the application providers configured in the IAM Identity Center identity store.

Parameter Syntax

$result = $client->listApplicationProviders([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ApplicationProviders' => [
        [
            'ApplicationProviderArn' => '<string>',
            'DisplayData' => [
                'Description' => '<string>',
                'DisplayName' => '<string>',
                'IconUrl' => '<string>',
            ],
            'FederationProtocol' => 'SAML|OAUTH',
            'ResourceServerConfig' => [
                'Scopes' => [
                    '<ResourceServerScope>' => [
                        'DetailedTitle' => '<string>',
                        'LongDescription' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listApplications([
    'Filter' => [
        'ApplicationAccount' => '<string>',
        'ApplicationProvider' => '<string>',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Applications' => [
        [
            'ApplicationAccount' => '<string>',
            'ApplicationArn' => '<string>',
            'ApplicationProviderArn' => '<string>',
            'CreatedDate' => <DateTime>,
            'Description' => '<string>',
            'InstanceArn' => '<string>',
            'Name' => '<string>',
            'PortalOptions' => [
                'SignInOptions' => [
                    'ApplicationUrl' => '<string>',
                    'Origin' => 'IDENTITY_CENTER|APPLICATION',
                ],
                'Visibility' => 'ENABLED|DISABLED',
            ],
            'Status' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListCustomerManagedPolicyReferencesInPermissionSet

$result = $client->listCustomerManagedPolicyReferencesInPermissionSet([/* ... */]);
$promise = $client->listCustomerManagedPolicyReferencesInPermissionSetAsync([/* ... */]);

Lists all customer managed policies attached to a specified PermissionSet.

Parameter Syntax

$result = $client->listCustomerManagedPolicyReferencesInPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CustomerManagedPolicyReferences' => [
        [
            'Name' => '<string>',
            'Path' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListInstances

$result = $client->listInstances([/* ... */]);
$promise = $client->listInstancesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listInstances([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Instances' => [
        [
            'CreatedDate' => <DateTime>,
            'IdentityStoreId' => '<string>',
            'InstanceArn' => '<string>',
            'Name' => '<string>',
            'OwnerAccountId' => '<string>',
            'Status' => 'CREATE_IN_PROGRESS|DELETE_IN_PROGRESS|ACTIVE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListManagedPoliciesInPermissionSet

$result = $client->listManagedPoliciesInPermissionSet([/* ... */]);
$promise = $client->listManagedPoliciesInPermissionSetAsync([/* ... */]);

Lists the Amazon Web Services managed policy that is attached to a specified permission set.

Parameter Syntax

$result = $client->listManagedPoliciesInPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AttachedManagedPolicies' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListPermissionSetProvisioningStatus

$result = $client->listPermissionSetProvisioningStatus([/* ... */]);
$promise = $client->listPermissionSetProvisioningStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPermissionSetProvisioningStatus([
    'Filter' => [
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
    ],
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PermissionSetsProvisioningStatus' => [
        [
            'CreatedDate' => <DateTime>,
            'RequestId' => '<string>',
            'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListPermissionSets

$result = $client->listPermissionSets([/* ... */]);
$promise = $client->listPermissionSetsAsync([/* ... */]);

Lists the PermissionSets in an IAM Identity Center instance.

Parameter Syntax

$result = $client->listPermissionSets([
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PermissionSets' => ['<string>', ...],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListPermissionSetsProvisionedToAccount

$result = $client->listPermissionSetsProvisionedToAccount([/* ... */]);
$promise = $client->listPermissionSetsProvisionedToAccountAsync([/* ... */]);

Lists all the permission sets that are provisioned to a specified Amazon Web Services account.

Parameter Syntax

$result = $client->listPermissionSetsProvisionedToAccount([
    'AccountId' => '<string>', // REQUIRED
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProvisioningStatus' => 'LATEST_PERMISSION_SET_PROVISIONED|LATEST_PERMISSION_SET_NOT_PROVISIONED',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PermissionSets' => ['<string>', ...],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags that are attached to a specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'InstanceArn' => '<string>',
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ListTrustedTokenIssuers

$result = $client->listTrustedTokenIssuers([/* ... */]);
$promise = $client->listTrustedTokenIssuersAsync([/* ... */]);

Lists all the trusted token issuers configured in an instance of IAM Identity Center.

Parameter Syntax

$result = $client->listTrustedTokenIssuers([
    'InstanceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TrustedTokenIssuers' => [
        [
            'Name' => '<string>',
            'TrustedTokenIssuerArn' => '<string>',
            'TrustedTokenIssuerType' => 'OIDC_JWT',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

ProvisionPermissionSet

$result = $client->provisionPermissionSet([/* ... */]);
$promise = $client->provisionPermissionSetAsync([/* ... */]);

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

Parameter Syntax

$result = $client->provisionPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
    'TargetId' => '<string>',
    'TargetType' => 'AWS_ACCOUNT|ALL_PROVISIONED_ACCOUNTS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PermissionSetProvisioningStatus' => [
        'AccountId' => '<string>',
        'CreatedDate' => <DateTime>,
        'FailureReason' => '<string>',
        'PermissionSetArn' => '<string>',
        'RequestId' => '<string>',
        'Status' => 'IN_PROGRESS|FAILED|SUCCEEDED',
    ],
]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

PutApplicationAccessScope

$result = $client->putApplicationAccessScope([/* ... */]);
$promise = $client->putApplicationAccessScopeAsync([/* ... */]);

Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.

Parameter Syntax

$result = $client->putApplicationAccessScope([
    'ApplicationArn' => '<string>', // REQUIRED
    'AuthorizedTargets' => ['<string>', ...],
    'Scope' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

PutApplicationAssignmentConfiguration

$result = $client->putApplicationAssignmentConfiguration([/* ... */]);
$promise = $client->putApplicationAssignmentConfigurationAsync([/* ... */]);

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. If false, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.

Parameter Syntax

$result = $client->putApplicationAssignmentConfiguration([
    'ApplicationArn' => '<string>', // REQUIRED
    'AssignmentRequired' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

PutApplicationAuthenticationMethod

$result = $client->putApplicationAuthenticationMethod([/* ... */]);
$promise = $client->putApplicationAuthenticationMethodAsync([/* ... */]);

Adds or updates an authentication method for an application.

Parameter Syntax

$result = $client->putApplicationAuthenticationMethod([
    'ApplicationArn' => '<string>', // REQUIRED
    'AuthenticationMethod' => [ // REQUIRED
        'Iam' => [
            'ActorPolicy' => [ // REQUIRED
            ],
        ],
    ],
    'AuthenticationMethodType' => 'IAM', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

PutApplicationGrant

$result = $client->putApplicationGrant([/* ... */]);
$promise = $client->putApplicationGrantAsync([/* ... */]);

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.

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 Amazon Web Services resources on behalf of users. The following elements are within these exchanges:

• Requester - The application requesting access to Amazon Web Services resources.

• Subject - Typically the user that is requesting access to Amazon Web Services resources.

• Grant - Conceptually, a grant is authorization to access Amazon Web Services 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.

  • 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.

• 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.

Use cases

• Connecting to custom applications.

• Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.

Parameter Syntax

$result = $client->putApplicationGrant([
    'ApplicationArn' => '<string>', // REQUIRED
    'Grant' => [ // REQUIRED
        'AuthorizationCode' => [
            'RedirectUris' => ['<string>', ...],
        ],
        'JwtBearer' => [
            'AuthorizedTokenIssuers' => [
                [
                    'AuthorizedAudiences' => ['<string>', ...],
                    'TrustedTokenIssuerArn' => '<string>',
                ],
                // ...
            ],
        ],
        'RefreshToken' => [
        ],
        'TokenExchange' => [
        ],
    ],
    'GrantType' => 'authorization_code|refresh_token|urn:ietf:params:oauth:grant-type:jwt-bearer|urn:ietf:params:oauth:grant-type:token-exchange', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

PutInlinePolicyToPermissionSet

$result = $client->putInlinePolicyToPermissionSet([/* ... */]);
$promise = $client->putInlinePolicyToPermissionSetAsync([/* ... */]);

Attaches an inline policy to a permission set.

Parameter Syntax

$result = $client->putInlinePolicyToPermissionSet([
    'InlinePolicy' => '<string>', // REQUIRED
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

PutPermissionsBoundaryToPermissionSet

$result = $client->putPermissionsBoundaryToPermissionSet([/* ... */]);
$promise = $client->putPermissionsBoundaryToPermissionSetAsync([/* ... */]);

Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.

Parameter Syntax

$result = $client->putPermissionsBoundaryToPermissionSet([
    'InstanceArn' => '<string>', // REQUIRED
    'PermissionSetArn' => '<string>', // REQUIRED
    'PermissionsBoundary' => [ // REQUIRED
        'CustomerManagedPolicyReference' => [
            'Name' => '<string>', // REQUIRED
            'Path' => '<string>',
        ],
        'ManagedPolicyArn' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates a set of tags with a specified resource.

Parameter Syntax

$result = $client->tagResource([
    'InstanceArn' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

Indicates that the principal has crossed the permitted number of resources that can be created.

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Disassociates a set of tags from a specified resource.

Parameter Syntax

$result = $client->untagResource([
    'InstanceArn' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException:

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException:

Indicates that a requested resource is not found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The request failed because it contains a syntax error.

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.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates application properties.

Parameter Syntax

$result = $client->updateApplication([
    'ApplicationArn' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>',
    'PortalOptions' => [
        'SignInOptions' => [
            'ApplicationUrl' => '<string>',
            'Origin' => 'IDENTITY_CENTER|APPLICATION', // REQUIRED
        ],
    ],
    'Status' => 'ENABLED|DISABLED',
]);

Parameter Details