Skip to content

delete_gcm_channel 

delete_gcm_channel(
    application_id: __string, *, config_overrides: Optional[PinpointClientConfig] = None
) -> DeleteGcmChannelResponse

Disables the GCM channel for an application and deletes any existing settings for the channel.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
def delete_gcm_channel(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> "capo_pinpoint.types.delete_gcm_channel_response.DeleteGcmChannelResponse":
    """<p>Disables the GCM channel for an application and deletes any existing settings for the channel.</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>

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

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.delete_gcm_channel_request.DeleteGcmChannelRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.delete_gcm_channel_response.DeleteGcmChannelResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.delete_gcm_channel

        output, http_response = (
            capo_pinpoint._operations.pinpoint.delete_gcm_channel.delete_gcm_channel(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteGcmChannel")
    )
    input_: capo_pinpoint.types.delete_gcm_channel_request.DeleteGcmChannelRequest = {
        "application_id": application_id
    }

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