remove_attributes `async` ¶

remove_attributes(
    application_id: __string,
    attribute_type: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    update_attributes_request: Optional[UpdateAttributesRequest] = None,
) -> RemoveAttributesResponse

Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.

Parameters:

application_id (__string) –

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
attribute_type (__string) –
The type of attribute or attributes to remove. Valid values are:
- endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
- endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
- endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

Raises:

BadRequestException –

Provides information about an API request or response.
ForbiddenException –

Provides information about an API request or response.
InternalServerErrorException –

Provides information about an API request or response.
MethodNotAllowedException –

Provides information about an API request or response.
NotFoundException –

Provides information about an API request or response.
PayloadTooLargeException –

Provides information about an API request or response.
TooManyRequestsException –

Provides information about an API request or response.
UnknownServiceError –

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

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py

async def remove_attributes(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    attribute_type: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
    update_attributes_request: Optional[
        "capo_pinpoint.types.update_attributes_request.UpdateAttributesRequest"
    ] = None,
) -> "capo_pinpoint.types.remove_attributes_response.RemoveAttributesResponse":
    """<p>Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
        attribute_type: <p>The type of attribute or attributes to remove. Valid values are:</p> <ul><li><p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li> <li><p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li> <li><p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li></ul>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint.types.remove_attributes_request.RemoveAttributesRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.remove_attributes_response.RemoveAttributesResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.remove_attributes

        (
            output,
            http_response,
        ) = await capo_pinpoint._operations.pinpoint.remove_attributes.async_remove_attributes(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RemoveAttributes")
    )
    input_: capo_pinpoint.types.remove_attributes_request.RemoveAttributesRequest = {
        "application_id": application_id,
        "attribute_type": attribute_type,
    }
    if update_attributes_request is not None:
        input_["update_attributes_request"] = update_attributes_request

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

remove_attributes async ¶

remove_attributes `async` ¶