PartnerCentralChannelAPI / Client / create_channel_handshake

create_channel_handshake¶

PartnerCentralChannelAPI.Client.create_channel_handshake(**kwargs)¶

Creates a new channel handshake request to establish a partnership with another AWS account.

Request Syntax

response = client.create_channel_handshake(
    handshakeType='START_SERVICE_PERIOD'|'REVOKE_SERVICE_PERIOD'|'PROGRAM_MANAGEMENT_ACCOUNT',
    catalog='string',
    associatedResourceIdentifier='string',
    payload={
        'startServicePeriodPayload': {
            'programManagementAccountIdentifier': 'string',
            'note': 'string',
            'servicePeriodType': 'MINIMUM_NOTICE_PERIOD'|'FIXED_COMMITMENT_PERIOD',
            'minimumNoticeDays': 'string',
            'endDate': datetime(2015, 1, 1)
        },
        'revokeServicePeriodPayload': {
            'programManagementAccountIdentifier': 'string',
            'note': 'string'
        }
    },
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

handshakeType (string) –
[REQUIRED]

The type of handshake to create (e.g., start service period, revoke service period).
catalog (string) –
[REQUIRED]

The catalog identifier for the handshake request.
associatedResourceIdentifier (string) –
[REQUIRED]

The identifier of the resource associated with this handshake.
payload (dict) –
The payload containing specific details for the handshake type.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: startServicePeriodPayload, revokeServicePeriodPayload.
- startServicePeriodPayload (dict) –
  
  Payload for starting a service period handshake.
  - programManagementAccountIdentifier (string) – [REQUIRED]
    
    The identifier of the program management account.
  - note (string) –
    
    A note providing additional information about the service period.
  - servicePeriodType (string) – [REQUIRED]
    
    The type of service period being started.
  - minimumNoticeDays (string) –
    
    The minimum number of days notice required for changes.
  - endDate (datetime) –
    
    The end date of the service period.
- revokeServicePeriodPayload (dict) –
  
  Payload for revoking a service period handshake.
  - programManagementAccountIdentifier (string) – [REQUIRED]
    
    The identifier of the program management account.
  - note (string) –
    
    A note explaining the reason for revoking the service period.
clientToken (string) –
A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.
tags (list) –
Key-value pairs to associate with the channel handshake.
- (dict) –
  
  A key-value pair that can be associated with a resource.
  - key (string) – [REQUIRED]
    
    The key of the tag.
  - value (string) – [REQUIRED]
    
    The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'channelHandshakeDetail': {
        'id': 'string',
        'arn': 'string'
    }
}

Response Structure

(dict) –
- channelHandshakeDetail (dict) –
  
  Details of the created channel handshake.
  - id (string) –
    
    The unique identifier of the created handshake.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the created handshake.

Exceptions

PartnerCentralChannelAPI.Client.exceptions.ResourceNotFoundException
PartnerCentralChannelAPI.Client.exceptions.InternalServerException
PartnerCentralChannelAPI.Client.exceptions.ValidationException
PartnerCentralChannelAPI.Client.exceptions.ThrottlingException
PartnerCentralChannelAPI.Client.exceptions.AccessDeniedException
PartnerCentralChannelAPI.Client.exceptions.ConflictException
PartnerCentralChannelAPI.Client.exceptions.ServiceQuotaExceededException