delete_predefined_attribute `async` ¶

delete_predefined_attribute(
    instance_id: InstanceId,
    name: PredefinedAttributeName,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> None

Deletes a predefined attribute from the specified Connect Customer instance.

Parameters:

instance_id (InstanceId) –

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
name (PredefinedAttributeName) –

The name of the predefined attribute.

Raises:

InternalServiceException –

Request processing failed because of an error or failure with the service.
InvalidParameterException –

One or more of the specified parameters are not valid.
InvalidRequestException –

The request is not valid.
ResourceInUseException –

That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.
ResourceNotFoundException –

The specified resource was not found.
ThrottlingException –

The throttling limit has been exceeded.
UnknownServiceError –

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

Source code in docs_src/capo_connect/_services/async_connect.py

async def delete_predefined_attribute(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    name: "capo_connect.types.predefined_attribute_name.PredefinedAttributeName",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> None:
    """<p>Deletes a predefined attribute from the specified Connect Customer instance.</p>

    Args:
        instance_id: <p> The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>
        name: <p> The name of the predefined attribute.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_in_use_exception.ResourceInUseException: <p>That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.delete_predefined_attribute_request.DeletePredefinedAttributeRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.delete_predefined_attribute

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.delete_predefined_attribute.async_delete_predefined_attribute(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePredefinedAttribute")
    )
    input_: capo_connect.types.delete_predefined_attribute_request.DeletePredefinedAttributeRequest = {
        "instance_id": instance_id,
        "name": name,
    }

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

delete_predefined_attribute async ¶

delete_predefined_attribute `async` ¶