Pinpoint / Client / update_baidu_channel

update_baidu_channel#

Pinpoint.Client.update_baidu_channel(**kwargs)#

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

Request Syntax

response = client.update_baidu_channel(
    ApplicationId='string',
    BaiduChannelRequest={
        'ApiKey': 'string',
        'Enabled': True|False,
        'SecretKey': 'string'
    }
)

Parameters:

ApplicationId (string) –
[REQUIRED]

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

Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
- ApiKey (string) – [REQUIRED]
  
  The API key that you received from the Baidu Cloud Push service to communicate with the service.
- Enabled (boolean) –
  
  Specifies whether to enable the Baidu channel for the application.
- SecretKey (string) – [REQUIRED]
  
  The secret key that you received from the Baidu Cloud Push service to communicate with the service.

Return type:

dict

Returns:

Response Syntax

{
    'BaiduChannelResponse': {
        '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.
- BaiduChannelResponse (dict) –
  
  Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
  - ApplicationId (string) –
    
    The unique identifier for the application that the Baidu channel applies to.
  - CreationDate (string) –
    
    The date and time when the Baidu channel was enabled.
  - Credential (string) –
    
    The API key that you received from the Baidu Cloud Push service to communicate with the service.
  - Enabled (boolean) –
    
    Specifies whether the Baidu 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 Baidu channel. This property is retained only for backward compatibility.
  - IsArchived (boolean) –
    
    Specifies whether the Baidu channel is archived.
  - LastModifiedBy (string) –
    
    The user who last modified the Baidu channel.
  - LastModifiedDate (string) –
    
    The date and time when the Baidu channel was last modified.
  - Platform (string) –
    
    The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
  - Version (integer) –
    
    The current version of the Baidu 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