Skip to content

unlink_developer_identity async

unlink_developer_identity(
    identity_id: IdentityId,
    identity_pool_id: IdentityPoolId,
    developer_provider_name: DeveloperProviderName,
    developer_user_identifier: DeveloperUserIdentifier,
    *,
    config_overrides: Optional[AsyncCognitoIdentityClientConfig] = None,
) -> None

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

You must use Amazon Web Services developer credentials to call this operation.

Parameters:

  • identity_id (IdentityId) –

    A unique identifier in the format REGION:GUID.

  • identity_pool_id (IdentityPoolId) –

    An identity pool ID in the format REGION:GUID.

  • developer_provider_name (DeveloperProviderName) –

    The "domain" by which Cognito will refer to your users.

  • developer_user_identifier (DeveloperUserIdentifier) –

    A unique ID used by your backend authentication process to identify a user.

Raises:

Source code in docs_src/capo_cognito_identity/_services/async_cognito_identity.py
async def unlink_developer_identity(
    self,
    identity_id: "capo_cognito_identity.types.identity_id.IdentityId",
    identity_pool_id: "capo_cognito_identity.types.identity_pool_id.IdentityPoolId",
    developer_provider_name: "capo_cognito_identity.types.developer_provider_name.DeveloperProviderName",
    developer_user_identifier: "capo_cognito_identity.types.developer_user_identifier.DeveloperUserIdentifier",
    *,
    config_overrides: Optional[AsyncCognitoIdentityClientConfig] = None,
) -> None:
    """<p>Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.</p> <p>You must use Amazon Web Services developer credentials to call this operation.</p>

    Args:
        identity_id: <p>A unique identifier in the format REGION:GUID.</p>
        identity_pool_id: <p>An identity pool ID in the format REGION:GUID.</p>
        developer_provider_name: <p>The "domain" by which Cognito will refer to your users.</p>
        developer_user_identifier: <p>A unique ID used by your backend authentication process to identify a user.</p>

    Raises:
        capo_cognito_identity.errors.internal_error_exception.InternalErrorException: <p>Thrown when the service encounters an error during processing the request.</p>
        capo_cognito_identity.errors.invalid_parameter_exception.InvalidParameterException: <p>Thrown for missing or bad input parameter(s).</p>
        capo_cognito_identity.errors.not_authorized_exception.NotAuthorizedException: <p>Thrown when a user is not authorized to access the requested resource.</p>
        capo_cognito_identity.errors.resource_conflict_exception.ResourceConflictException: <p>Thrown when a user tries to use a login which is already linked to another account.</p>
        capo_cognito_identity.errors.resource_not_found_exception.ResourceNotFoundException: <p>Thrown when the requested resource (for example, a dataset or record) does not exist.</p>
        capo_cognito_identity.errors.too_many_requests_exception.TooManyRequestsException: <p>Thrown when a request is throttled.</p>
        capo_cognito_identity.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity.types.unlink_developer_identity_input.UnlinkDeveloperIdentityInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_cognito_identity._operations.aws_cognito_identity_service.unlink_developer_identity

        (
            output,
            http_response,
        ) = await capo_cognito_identity._operations.aws_cognito_identity_service.unlink_developer_identity.async_unlink_developer_identity(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UnlinkDeveloperIdentity")
    )
    input_: capo_cognito_identity.types.unlink_developer_identity_input.UnlinkDeveloperIdentityInput = {
        "identity_id": identity_id,
        "identity_pool_id": identity_pool_id,
        "developer_provider_name": developer_provider_name,
        "developer_user_identifier": developer_user_identifier,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output