Partner Central Channel API

Updates the properties of a program management account.

See also: AWS API Documentation

Request Syntax

client.update_program_management_account(
    catalog='string',
    identifier='string',
    revision='string',
    displayName='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the program management account.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the program management account to update.

type revision:

string

param revision:

The current revision number of the program management account.

type displayName:

string

param displayName:

The new display name for the program management account.

rtype:

dict

returns:

Response Syntax

{
    'programManagementAccountDetail': {
        'id': 'string',
        'arn': 'string',
        'revision': 'string',
        'displayName': 'string'
    }
}

Response Structure

• (dict) --

  • programManagementAccountDetail (dict) --

    Details of the updated program management account.

    • id (string) --

      The unique identifier of the updated program management account.

    • arn (string) --

      The Amazon Resource Name (ARN) of the updated program management account.

    • revision (string) --

      The new revision number of the program management account.

    • displayName (string) --

      The updated display name of the program management account.

Creates a new program management account for managing partner relationships.

See also: AWS API Documentation

Request Syntax

client.create_program_management_account(
    catalog='string',
    program='SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER',
    displayName='string',
    accountId='string',
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the program management account.

type program:

string

param program:

[REQUIRED]

The program type for the management account.

type displayName:

string

param displayName:

[REQUIRED]

A human-readable name for the program management account.

type accountId:

string

param accountId:

[REQUIRED]

The AWS account ID to associate with the program management account.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

type tags:

list

param tags:

Key-value pairs to associate with the program management account.

• (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.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • programManagementAccountDetail (dict) --

    Details of the created program management account.

    • id (string) --

      The unique identifier of the created program management account.

    • arn (string) --

      The Amazon Resource Name (ARN) of the created program management account.

Cancels a pending channel handshake request.

See also: AWS API Documentation

Request Syntax

client.cancel_channel_handshake(
    catalog='string',
    identifier='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the handshake request.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the channel handshake to cancel.

rtype:

dict

returns:

Response Syntax

{
    'channelHandshakeDetail': {
        'id': 'string',
        'arn': 'string',
        'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
    }
}

Response Structure

• (dict) --

  • channelHandshakeDetail (dict) --

    Details of the canceled channel handshake.

    • id (string) --

      The unique identifier of the canceled handshake.

    • arn (string) --

      The Amazon Resource Name (ARN) of the canceled handshake.

    • status (string) --

      The current status of the canceled handshake.

Adds or updates tags for a specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to tag.

type tags:

list

param tags:

[REQUIRED]

Key-value pairs to associate with the resource.

• (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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists program management accounts based on specified criteria.

See also: AWS API Documentation

Request Syntax

client.list_program_management_accounts(
    catalog='string',
    maxResults=123,
    displayNames=[
        'string',
    ],
    programs=[
        'SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER',
    ],
    accountIds=[
        'string',
    ],
    statuses=[
        'PENDING'|'ACTIVE'|'INACTIVE',
    ],
    sort={
        'sortOrder': 'Ascending'|'Descending',
        'sortBy': 'UpdatedAt'
    },
    nextToken='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier to filter accounts.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type displayNames:

list

param displayNames:

Filter by display names.

• (string) --

type programs:

list

param programs:

Filter by program types.

• (string) --

type accountIds:

list

param accountIds:

Filter by AWS account IDs.

• (string) --

type statuses:

list

param statuses:

Filter by program management account statuses.

• (string) --

type sort:

dict

param sort:

Sorting options for the results.

• sortOrder (string) -- [REQUIRED]

  The sort order (ascending or descending).

• sortBy (string) -- [REQUIRED]

  The field to sort by.

type nextToken:

string

param nextToken:

Token for retrieving the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'revision': 'string',
            'catalog': 'string',
            'program': 'SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER',
            'displayName': 'string',
            'accountId': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'startDate': datetime(2015, 1, 1),
            'status': 'PENDING'|'ACTIVE'|'INACTIVE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    List of program management accounts matching the criteria.

    • (dict) --

      Summary information about a program management account.

      • id (string) --

        The unique identifier of the program management account.

      • revision (string) --

        The current revision number of the program management account.

      • catalog (string) --

        The catalog identifier associated with the account.

      • program (string) --

        The program type for the management account.

      • displayName (string) --

        The display name of the program management account.

      • accountId (string) --

        The AWS account ID associated with the program management account.

      • arn (string) --

        The Amazon Resource Name (ARN) of the program management account.

      • createdAt (datetime) --

        The timestamp when the account was created.

      • updatedAt (datetime) --

        The timestamp when the account was last updated.

      • startDate (datetime) --

        The start date of the program management account.

      • status (string) --

        The current status of the program management account.

  • nextToken (string) --

    Token for retrieving the next page of results, if available.

Deletes a program management account.

See also: AWS API Documentation

Request Syntax

client.delete_program_management_account(
    catalog='string',
    identifier='string',
    clientToken='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the program management account.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the program management account to delete.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Lists partner relationships based on specified criteria.

See also: AWS API Documentation

Request Syntax

client.list_relationships(
    catalog='string',
    maxResults=123,
    associatedAccountIds=[
        'string',
    ],
    associationTypes=[
        'DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
    ],
    displayNames=[
        'string',
    ],
    programManagementAccountIdentifiers=[
        'string',
    ],
    sort={
        'sortOrder': 'Ascending'|'Descending',
        'sortBy': 'UpdatedAt'
    },
    nextToken='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier to filter relationships.

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type associatedAccountIds:

list

param associatedAccountIds:

Filter by associated AWS account IDs.

• (string) --

type associationTypes:

list

param associationTypes:

Filter by association types.

• (string) --

type displayNames:

list

param displayNames:

Filter by display names.

• (string) --

type programManagementAccountIdentifiers:

list

param programManagementAccountIdentifiers:

Filter by program management account identifiers.

• (string) --

type sort:

dict

param sort:

Sorting options for the results.

• sortOrder (string) -- [REQUIRED]

  The sort order (ascending or descending).

• sortBy (string) -- [REQUIRED]

  The field to sort by.

type nextToken:

string

param nextToken:

Token for retrieving the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'id': 'string',
            'revision': 'string',
            'catalog': 'string',
            'associationType': 'DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
            'programManagementAccountId': 'string',
            'associatedAccountId': 'string',
            'displayName': 'string',
            'sector': 'COMMERCIAL'|'GOVERNMENT'|'GOVERNMENT_EXCEPTION',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'startDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    List of relationships matching the criteria.

    • (dict) --

      Summary information about a partner relationship.

      • arn (string) --

        The Amazon Resource Name (ARN) of the relationship.

      • id (string) --

        The unique identifier of the relationship.

      • revision (string) --

        The current revision number of the relationship.

      • catalog (string) --

        The catalog identifier associated with the relationship.

      • associationType (string) --

        The type of association for the relationship.

      • programManagementAccountId (string) --

        The identifier of the program management account.

      • associatedAccountId (string) --

        The AWS account ID associated in this relationship.

      • displayName (string) --

        The display name of the relationship.

      • sector (string) --

        The business sector for the relationship.

      • createdAt (datetime) --

        The timestamp when the relationship was created.

      • updatedAt (datetime) --

        The timestamp when the relationship was last updated.

      • startDate (datetime) --

        The start date of the relationship.

  • nextToken (string) --

    Token for retrieving the next page of results, if available.

Retrieves details of a specific partner relationship.

See also: AWS API Documentation

Request Syntax

client.get_relationship(
    catalog='string',
    programManagementAccountIdentifier='string',
    identifier='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the relationship.

type programManagementAccountIdentifier:

string

param programManagementAccountIdentifier:

[REQUIRED]

The identifier of the program management account associated with the relationship.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the relationship to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'relationshipDetail': {
        'arn': 'string',
        'id': 'string',
        'revision': 'string',
        'catalog': 'string',
        'associationType': 'DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
        'programManagementAccountId': 'string',
        'associatedAccountId': 'string',
        'displayName': 'string',
        'resaleAccountModel': 'DISTRIBUTOR'|'END_CUSTOMER'|'SOLUTION_PROVIDER',
        'sector': 'COMMERCIAL'|'GOVERNMENT'|'GOVERNMENT_EXCEPTION',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'startDate': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • relationshipDetail (dict) --

    Details of the requested relationship.

    • arn (string) --

      The Amazon Resource Name (ARN) of the relationship.

    • id (string) --

      The unique identifier of the relationship.

    • revision (string) --

      The current revision number of the relationship.

    • catalog (string) --

      The catalog identifier associated with the relationship.

    • associationType (string) --

      The type of association for the relationship.

    • programManagementAccountId (string) --

      The identifier of the program management account.

    • associatedAccountId (string) --

      The AWS account ID associated in this relationship.

    • displayName (string) --

      The display name of the relationship.

    • resaleAccountModel (string) --

      The resale account model for the relationship.

    • sector (string) --

      The business sector for the relationship.

    • createdAt (datetime) --

      The timestamp when the relationship was created.

    • updatedAt (datetime) --

      The timestamp when the relationship was last updated.

    • startDate (datetime) --

      The start date of the relationship.

Lists tags associated with a specific resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to list tags for.

rtype:

dict

returns:

Response Syntax

{
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • tags (list) --

    Key-value pairs associated with the resource.

    • (dict) --

      A key-value pair that can be associated with a resource.

      • key (string) --

        The key of the tag.

      • value (string) --

        The value of the tag.

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

See also: AWS API Documentation

Request Syntax

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'
        },
    ]
)

type handshakeType:

string

param handshakeType:

[REQUIRED]

The type of handshake to create (e.g., start service period, revoke service period).

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the handshake request.

type associatedResourceIdentifier:

string

param associatedResourceIdentifier:

[REQUIRED]

The identifier of the resource associated with this handshake.

type payload:

dict

param payload:

The payload containing specific details for the handshake type.

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

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

type tags:

list

param tags:

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.

rtype:

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.

Rejects a pending channel handshake request.

See also: AWS API Documentation

Request Syntax

client.reject_channel_handshake(
    catalog='string',
    identifier='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the handshake request.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the channel handshake to reject.

rtype:

dict

returns:

Response Syntax

{
    'channelHandshakeDetail': {
        'id': 'string',
        'arn': 'string',
        'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
    }
}

Response Structure

• (dict) --

  • channelHandshakeDetail (dict) --

    Details of the rejected channel handshake.

    • id (string) --

      The unique identifier of the rejected handshake.

    • arn (string) --

      The Amazon Resource Name (ARN) of the rejected handshake.

    • status (string) --

      The current status of the rejected handshake.

Removes tags from a specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to remove tags from.

type tagKeys:

list

param tagKeys:

[REQUIRED]

The keys of the tags to remove from the resource.

• (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates the properties of a partner relationship.

See also: AWS API Documentation

Request Syntax

client.update_relationship(
    catalog='string',
    identifier='string',
    programManagementAccountIdentifier='string',
    revision='string',
    displayName='string',
    requestedSupportPlan={
        'resoldBusiness': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY'
        },
        'resoldEnterprise': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY',
            'tamLocation': 'string',
            'chargeAccountId': 'string'
        },
        'partnerLedSupport': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY',
            'provider': 'DISTRIBUTOR'|'DISTRIBUTION_SELLER',
            'tamLocation': 'string'
        }
    }
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the relationship.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the relationship to update.

type programManagementAccountIdentifier:

string

param programManagementAccountIdentifier:

[REQUIRED]

The identifier of the program management account associated with the relationship.

type revision:

string

param revision:

The current revision number of the relationship.

type displayName:

string

param displayName:

The new display name for the relationship.

type requestedSupportPlan:

dict

param requestedSupportPlan:

The updated support plan for the relationship.

• resoldBusiness (dict) --

  Configuration for resold business support plans.

  • coverage (string) -- [REQUIRED]

    The coverage level for resold business support.

• resoldEnterprise (dict) --

  Configuration for resold enterprise support plans.

  • coverage (string) -- [REQUIRED]

    The coverage level for resold enterprise support.

  • tamLocation (string) -- [REQUIRED]

    The location of the Technical Account Manager (TAM).

  • chargeAccountId (string) --

    The AWS account ID to charge for the support plan.

• partnerLedSupport (dict) --

  Configuration for partner-led support plans.

  • coverage (string) -- [REQUIRED]

    The coverage level for partner-led support.

  • provider (string) --

    The provider of the partner-led support.

  • tamLocation (string) -- [REQUIRED]

    The location of the Technical Account Manager (TAM).

rtype:

dict

returns:

Response Syntax

{
    'relationshipDetail': {
        'arn': 'string',
        'id': 'string',
        'revision': 'string',
        'displayName': 'string'
    }
}

Response Structure

• (dict) --

  • relationshipDetail (dict) --

    Details of the updated relationship.

    • arn (string) --

      The Amazon Resource Name (ARN) of the updated relationship.

    • id (string) --

      The unique identifier of the updated relationship.

    • revision (string) --

      The new revision number of the relationship.

    • displayName (string) --

      The updated display name of the relationship.

Creates a new partner relationship between accounts.

See also: AWS API Documentation

Request Syntax

client.create_relationship(
    catalog='string',
    associationType='DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
    programManagementAccountIdentifier='string',
    associatedAccountId='string',
    displayName='string',
    resaleAccountModel='DISTRIBUTOR'|'END_CUSTOMER'|'SOLUTION_PROVIDER',
    sector='COMMERCIAL'|'GOVERNMENT'|'GOVERNMENT_EXCEPTION',
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    requestedSupportPlan={
        'resoldBusiness': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY'
        },
        'resoldEnterprise': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY',
            'tamLocation': 'string',
            'chargeAccountId': 'string'
        },
        'partnerLedSupport': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY',
            'provider': 'DISTRIBUTOR'|'DISTRIBUTION_SELLER',
            'tamLocation': 'string'
        }
    }
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the relationship.

type associationType:

string

param associationType:

[REQUIRED]

The type of association for the relationship (e.g., reseller, distributor).

type programManagementAccountIdentifier:

string

param programManagementAccountIdentifier:

[REQUIRED]

The identifier of the program management account for this relationship.

type associatedAccountId:

string

param associatedAccountId:

[REQUIRED]

The AWS account ID to associate in this relationship.

type displayName:

string

param displayName:

[REQUIRED]

A human-readable name for the relationship.

type resaleAccountModel:

string

param resaleAccountModel:

The resale account model for the relationship.

type sector:

string

param sector:

[REQUIRED]

The business sector for the relationship.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

type tags:

list

param tags:

Key-value pairs to associate with the relationship.

• (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.

type requestedSupportPlan:

dict

param requestedSupportPlan:

The support plan requested for this relationship.

• resoldBusiness (dict) --

  Configuration for resold business support plans.

  • coverage (string) -- [REQUIRED]

    The coverage level for resold business support.

• resoldEnterprise (dict) --

  Configuration for resold enterprise support plans.

  • coverage (string) -- [REQUIRED]

    The coverage level for resold enterprise support.

  • tamLocation (string) -- [REQUIRED]

    The location of the Technical Account Manager (TAM).

  • chargeAccountId (string) --

    The AWS account ID to charge for the support plan.

• partnerLedSupport (dict) --

  Configuration for partner-led support plans.

  • coverage (string) -- [REQUIRED]

    The coverage level for partner-led support.

  • provider (string) --

    The provider of the partner-led support.

  • tamLocation (string) -- [REQUIRED]

    The location of the Technical Account Manager (TAM).

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • relationshipDetail (dict) --

    Details of the created relationship.

    • arn (string) --

      The Amazon Resource Name (ARN) of the created relationship.

    • id (string) --

      The unique identifier of the created relationship.

Lists channel handshakes based on specified criteria.

See also: AWS API Documentation

Request Syntax

client.list_channel_handshakes(
    handshakeType='START_SERVICE_PERIOD'|'REVOKE_SERVICE_PERIOD'|'PROGRAM_MANAGEMENT_ACCOUNT',
    catalog='string',
    participantType='SENDER'|'RECEIVER',
    maxResults=123,
    statuses=[
        'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED',
    ],
    associatedResourceIdentifiers=[
        'string',
    ],
    handshakeTypeFilters={
        'startServicePeriodTypeFilters': {
            'servicePeriodTypes': [
                'MINIMUM_NOTICE_PERIOD'|'FIXED_COMMITMENT_PERIOD',
            ]
        },
        'revokeServicePeriodTypeFilters': {
            'servicePeriodTypes': [
                'MINIMUM_NOTICE_PERIOD'|'FIXED_COMMITMENT_PERIOD',
            ]
        },
        'programManagementAccountTypeFilters': {
            'programs': [
                'SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER',
            ]
        }
    },
    handshakeTypeSort={
        'startServicePeriodTypeSort': {
            'sortOrder': 'Ascending'|'Descending',
            'sortBy': 'UpdatedAt'
        },
        'revokeServicePeriodTypeSort': {
            'sortOrder': 'Ascending'|'Descending',
            'sortBy': 'UpdatedAt'
        },
        'programManagementAccountTypeSort': {
            'sortOrder': 'Ascending'|'Descending',
            'sortBy': 'UpdatedAt'
        }
    },
    nextToken='string'
)

type handshakeType:

string

param handshakeType:

[REQUIRED]

Filter results by handshake type.

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier to filter handshakes.

type participantType:

string

param participantType:

[REQUIRED]

Filter by participant type (sender or receiver).

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type statuses:

list

param statuses:

Filter results by handshake status.

• (string) --

type associatedResourceIdentifiers:

list

param associatedResourceIdentifiers:

Filter by associated resource identifiers.

• (string) --

type handshakeTypeFilters:

dict

param handshakeTypeFilters:

Type-specific filters for handshakes.

• startServicePeriodTypeFilters (dict) --

  Filters specific to start service period handshakes.

  • servicePeriodTypes (list) --

    Filter by service period types.

    • (string) --

• revokeServicePeriodTypeFilters (dict) --

  Filters specific to revoke service period handshakes.

  • servicePeriodTypes (list) --

    Filter by service period types.

    • (string) --

• programManagementAccountTypeFilters (dict) --

  Filters specific to program management account handshakes.

  • programs (list) --

    Filter by program types.

    • (string) --

type handshakeTypeSort:

dict

param handshakeTypeSort:

Type-specific sorting options for handshakes.

• startServicePeriodTypeSort (dict) --

  Sorting options specific to start service period handshakes.

  • sortOrder (string) -- [REQUIRED]

    The sort order (ascending or descending).

  • sortBy (string) -- [REQUIRED]

    The field to sort by.

• revokeServicePeriodTypeSort (dict) --

  Sorting options specific to revoke service period handshakes.

  • sortOrder (string) -- [REQUIRED]

    The sort order (ascending or descending).

  • sortBy (string) -- [REQUIRED]

    The field to sort by.

• programManagementAccountTypeSort (dict) --

  Sorting options specific to program management account handshakes.

  • sortOrder (string) -- [REQUIRED]

    The sort order (ascending or descending).

  • sortBy (string) -- [REQUIRED]

    The field to sort by.

type nextToken:

string

param nextToken:

Token for retrieving the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'arn': 'string',
            'catalog': 'string',
            'handshakeType': 'START_SERVICE_PERIOD'|'REVOKE_SERVICE_PERIOD'|'PROGRAM_MANAGEMENT_ACCOUNT',
            'ownerAccountId': 'string',
            'senderAccountId': 'string',
            'senderDisplayName': 'string',
            'receiverAccountId': 'string',
            'associatedResourceId': 'string',
            'detail': {
                'startServicePeriodHandshakeDetail': {
                    'note': 'string',
                    'servicePeriodType': 'MINIMUM_NOTICE_PERIOD'|'FIXED_COMMITMENT_PERIOD',
                    'minimumNoticeDays': 'string',
                    'startDate': datetime(2015, 1, 1),
                    'endDate': datetime(2015, 1, 1)
                },
                'revokeServicePeriodHandshakeDetail': {
                    'note': 'string',
                    'servicePeriodType': 'MINIMUM_NOTICE_PERIOD'|'FIXED_COMMITMENT_PERIOD',
                    'minimumNoticeDays': 'string',
                    'startDate': datetime(2015, 1, 1),
                    'endDate': datetime(2015, 1, 1)
                },
                'programManagementAccountHandshakeDetail': {
                    'program': 'SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    List of channel handshakes matching the criteria.

    • (dict) --

      Summary information about a channel handshake.

      • id (string) --

        The unique identifier of the handshake.

      • arn (string) --

        The Amazon Resource Name (ARN) of the handshake.

      • catalog (string) --

        The catalog identifier associated with the handshake.

      • handshakeType (string) --

        The type of the handshake.

      • ownerAccountId (string) --

        The AWS account ID of the handshake owner.

      • senderAccountId (string) --

        The AWS account ID of the handshake sender.

      • senderDisplayName (string) --

        The display name of the handshake sender.

      • receiverAccountId (string) --

        The AWS account ID of the handshake receiver.

      • associatedResourceId (string) --

        The identifier of the resource associated with the handshake.

      • detail (dict) --

        Detailed information about the handshake.

        • startServicePeriodHandshakeDetail (dict) --

          Details for a start service period handshake.

          • note (string) --

            A note providing additional information about the service period.

          • servicePeriodType (string) --

            The type of service period being started.

          • minimumNoticeDays (string) --

            The minimum number of days notice required for changes.

          • startDate (datetime) --

            The start date of the service period.

          • endDate (datetime) --

            The end date of the service period.

        • revokeServicePeriodHandshakeDetail (dict) --

          Details for a revoke service period handshake.

          • note (string) --

            A note explaining the reason for revoking the service period.

          • servicePeriodType (string) --

            The type of service period being revoked.

          • minimumNoticeDays (string) --

            The minimum number of days notice required for revocation.

          • startDate (datetime) --

            The start date of the service period being revoked.

          • endDate (datetime) --

            The end date of the service period being revoked.

        • programManagementAccountHandshakeDetail (dict) --

          Details for a program management account handshake.

          • program (string) --

            The program associated with the handshake.

      • createdAt (datetime) --

        The timestamp when the handshake was created.

      • updatedAt (datetime) --

        The timestamp when the handshake was last updated.

      • status (string) --

        The current status of the handshake.

  • nextToken (string) --

    Token for retrieving the next page of results, if available.

Accepts a pending channel handshake request from another AWS account.

See also: AWS API Documentation

Request Syntax

client.accept_channel_handshake(
    catalog='string',
    identifier='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the handshake request.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the channel handshake to accept.

rtype:

dict

returns:

Response Syntax

{
    'channelHandshakeDetail': {
        'id': 'string',
        'arn': 'string',
        'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
    }
}

Response Structure

• (dict) --

  • channelHandshakeDetail (dict) --

    Details of the accepted channel handshake.

    • id (string) --

      The unique identifier of the accepted handshake.

    • arn (string) --

      The Amazon Resource Name (ARN) of the accepted handshake.

    • status (string) --

      The current status of the accepted handshake.

Deletes a partner relationship.

See also: AWS API Documentation

Request Syntax

client.delete_relationship(
    catalog='string',
    identifier='string',
    programManagementAccountIdentifier='string',
    clientToken='string'
)

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the relationship.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the relationship to delete.

type programManagementAccountIdentifier:

string

param programManagementAccountIdentifier:

[REQUIRED]

The identifier of the program management account associated with the relationship.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --