get_gcm_channel ¶

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

Retrieves information about the status and settings of the GCM channel for an application.

Parameters:

application_id (__string) –

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

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/pinpoint.py

def get_gcm_channel(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> "capo_pinpoint.types.get_gcm_channel_response.GetGcmChannelResponse":
    """<p>Retrieves information about the status and settings of the GCM channel for an application.</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.get_gcm_channel_request.GetGcmChannelRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.get_gcm_channel_response.GetGcmChannelResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.get_gcm_channel

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetGcmChannel")
    )
    input_: capo_pinpoint.types.get_gcm_channel_request.GetGcmChannelRequest = {
        "application_id": application_id
    }

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