Pinpoint / Client / update_gcm_channel

update_gcm_channel#

Pinpoint.Client.update_gcm_channel(**kwargs)#

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

Request Syntax

response = client.update_gcm_channel(
    ApplicationId='string',
    GCMChannelRequest={
        'ApiKey': 'string',
        'Enabled': True|False
    }
)

Parameters:

ApplicationId (string) –
[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
GCMChannelRequest (dict) –
[REQUIRED]

Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
- ApiKey (string) – [REQUIRED]
  
  The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
- Enabled (boolean) –
  
  Specifies whether to enable the GCM channel for the application.

Return type:

dict

Returns:

Response Syntax

{
    'GCMChannelResponse': {
        'ApplicationId': 'string',
        'CreationDate': 'string',
        'Credential': 'string',
        'Enabled': True|False,
        'HasCredential': True|False,
        'Id': 'string',
        'IsArchived': True|False,
        'LastModifiedBy': 'string',
        'LastModifiedDate': 'string',
        'Platform': 'string',
        'Version': 123
    }
}

Response Structure

(dict) –

The request succeeded.
- GCMChannelResponse (dict) –
  
  Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
  - ApplicationId (string) –
    
    The unique identifier for the application that the GCM channel applies to.
  - CreationDate (string) –
    
    The date and time when the GCM channel was enabled.
  - Credential (string) –
    
    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
  - Enabled (boolean) –
    
    Specifies whether the GCM channel is enabled for the application.
  - HasCredential (boolean) –
    
    (Not used) This property is retained only for backward compatibility.
  - Id (string) –
    
    (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
  - IsArchived (boolean) –
    
    Specifies whether the GCM channel is archived.
  - LastModifiedBy (string) –
    
    The user who last modified the GCM channel.
  - LastModifiedDate (string) –
    
    The date and time when the GCM channel was last modified.
  - Platform (string) –
    
    The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
  - Version (integer) –
    
    The current version of the GCM channel.

Exceptions

Pinpoint.Client.exceptions.BadRequestException
Pinpoint.Client.exceptions.InternalServerErrorException
Pinpoint.Client.exceptions.PayloadTooLargeException
Pinpoint.Client.exceptions.ForbiddenException
Pinpoint.Client.exceptions.NotFoundException
Pinpoint.Client.exceptions.MethodNotAllowedException
Pinpoint.Client.exceptions.TooManyRequestsException