delete_application_assignment ¶

delete_application_assignment(
    application_arn: ApplicationArn,
    principal_id: PrincipalId,
    principal_type: PrincipalType,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> DeleteApplicationAssignmentResponse

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

Parameters:

application_arn (ApplicationArn) –

Specifies the ARN of the application.
principal_id (PrincipalId) –

An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
principal_type (PrincipalType) –

The entity type for which the assignment will be deleted.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
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.
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.
ThrottlingException –

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

The request failed because it contains a syntax error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sso_admin/_services/sso_admin.py

def delete_application_assignment(
    self,
    application_arn: "capo_sso_admin.types.application_arn.ApplicationArn",
    principal_id: "capo_sso_admin.types.principal_id.PrincipalId",
    principal_type: "capo_sso_admin.types.principal_type.PrincipalType",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> "capo_sso_admin.types.delete_application_assignment_response.DeleteApplicationAssignmentResponse":
    """<p>Revoke application access to an application by deleting application assignments for a user or group.</p>

    Args:
        application_arn: <p>Specifies the ARN of the application.</p>
        principal_id: <p>An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.</p>
        principal_type: <p>The entity type for which the assignment will be deleted.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.conflict_exception.ConflictException: <p>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.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sso_admin.types.delete_application_assignment_request.DeleteApplicationAssignmentRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.delete_application_assignment_response.DeleteApplicationAssignmentResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.delete_application_assignment

        output, http_response = (
            capo_sso_admin._operations.swb_external_service.delete_application_assignment.delete_application_assignment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteApplicationAssignment")
    )
    input_: capo_sso_admin.types.delete_application_assignment_request.DeleteApplicationAssignmentRequest = {
        "application_arn": application_arn,
        "principal_id": principal_id,
        "principal_type": principal_type,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output