Partner Central Channel API

2026/11/20 - Partner Central Channel API - 4 new6 updated api methods

Changes  Adds MSP program relationships support in AWS Partner Central. Partners can now create, update, list, and delete MSP relationships using the new MSP program type on the CreateProgramManagementAccount, CreateRelationship, UpdateRelationship, and ListRelationships operations.

CancelChannelContract (new) Link ¶

Cancels a pending channel contract created within the last 30 days. A request for a channel contract that isn't PENDING, including one that is already CANCELED, fails with a ValidationException.

See also: AWS API Documentation

Request Syntax

client.cancel_channel_contract(
    catalog='string',
    identifier='string',
    reason='string',
    clientToken='string'
)
type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the channel contract.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the channel contract to cancel.

type reason:

string

param reason:

The reason for canceling the channel contract. Later requests don't change or remove it.

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

{
    'channelContractDetail': {
        'id': 'string',
        'arn': 'string',
        'status': 'PENDING'|'ACCEPTED'|'EXPIRED'|'CANCELED'|'INACTIVE',
        'cancellationReason': 'string'
    }
}

Response Structure

  • (dict) --

    • channelContractDetail (dict) --

      Details of the canceled channel contract.

      • id (string) --

        The unique identifier of the canceled channel contract.

      • arn (string) --

        The Amazon Resource Name (ARN) of the canceled channel contract.

      • status (string) --

        The current status of the canceled channel contract.

      • cancellationReason (string) --

        The reason the channel contract was canceled, if one was provided.

GetChannelContract (new) Link ¶

Retrieves details of a specific channel contract.

See also: AWS API Documentation

Request Syntax

client.get_channel_contract(
    catalog='string',
    identifier='string'
)
type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the channel contract.

type identifier:

string

param identifier:

[REQUIRED]

The unique identifier of the channel contract to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'channelContractDetail': {
        'id': 'string',
        'arn': 'string',
        'catalog': 'string',
        'contractType': 'MANAGED_SERVICES_ATTESTATION',
        'status': 'PENDING'|'ACCEPTED'|'EXPIRED'|'CANCELED'|'INACTIVE',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'respondedAt': datetime(2015, 1, 1),
        'cancellationReason': 'string',
        'details': {
            'managedServicesAttestationDetails': {
                'legalEntityName': 'string',
                'relationshipIdentifier': 'string',
                'programManagementAccountIdentifier': 'string',
                'memberAccountIds': [
                    'string',
                ],
                'endDate': datetime(2015, 1, 1),
                'supportedServices': [
                    'MONITORING'|'PATCHING'|'SECURITY'|'BACKUP_AND_DISASTER_RECOVERY'|'FINANCIAL_OPERATIONS'|'INFRASTRUCTURE_AS_CODE_AND_AUTOMATION'|'WELL_ARCHITECTED'|'ARTIFICIAL_INTELLIGENCE_AND_MACHINE_LEARNING_OPERATIONS',
                ],
                'signatoryName': 'string',
                'signatoryEmail': 'string',
                'legalEntityAddress': {
                    'city': 'string',
                    'stateOrRegion': 'string',
                    'postalCode': 'string',
                    'countryCode': 'string',
                    'addressLine': 'string',
                    'addressLine2': 'string'
                }
            }
        }
    }
}

Response Structure

  • (dict) --

    • channelContractDetail (dict) --

      Details of the requested channel contract.

      • id (string) --

        The unique identifier of the channel contract.

      • arn (string) --

        The Amazon Resource Name (ARN) of the channel contract.

      • catalog (string) --

        The catalog identifier associated with the channel contract.

      • contractType (string) --

        The type of the channel contract.

      • status (string) --

        The current status of the channel contract.

      • createdAt (datetime) --

        The timestamp when the channel contract was created.

      • updatedAt (datetime) --

        The timestamp when the channel contract was last updated.

      • respondedAt (datetime) --

        The timestamp when the channel contract was accepted, if applicable.

      • cancellationReason (string) --

        The reason the channel contract was canceled, if one was provided.

      • details (dict) --

        Type-specific details of the channel contract.

        • managedServicesAttestationDetails (dict) --

          Details specific to managed services attestation channel contracts. Applies only to managed services attestation channel contracts.

          • legalEntityName (string) --

            The legal name of the end customer's legal entity.

          • relationshipIdentifier (string) --

            The identifier of the relationship covered by the attestation.

          • programManagementAccountIdentifier (string) --

            The identifier of the program management account.

          • memberAccountIds (list) --

            The AWS account IDs of the end customer's member accounts covered by the managed services.

            • (string) --

          • endDate (datetime) --

            The end date of the managed services attestation.

          • supportedServices (list) --

            The managed services that the partner provides to the end customer.

            • (string) --

          • signatoryName (string) --

            The name of the person who signs the attestation for the end customer.

          • signatoryEmail (string) --

            The email address of the signatory.

          • legalEntityAddress (dict) --

            The address of the end customer's legal entity, if available.

            • city (string) --

              The city or locality.

            • stateOrRegion (string) --

              The state, province, or prefecture.

            • postalCode (string) --

              The postal code.

            • countryCode (string) --

              The two-letter ISO 3166-1 country code.

            • addressLine (string) --

              The first line of the street address.

            • addressLine2 (string) --

              The second line of the street address.

CreateChannelContract (new) Link ¶

Creates a new channel contract and sends it to the signatory for signature. In the Sandbox catalog, the channel contract is accepted automatically.

See also: AWS API Documentation

Request Syntax

client.create_channel_contract(
    contractType='MANAGED_SERVICES_ATTESTATION',
    catalog='string',
    payload={
        'managedServicesAttestationPayload': {
            'legalEntityName': 'string',
            'relationshipIdentifier': 'string',
            'programManagementAccountIdentifier': 'string',
            'memberAccountIds': [
                'string',
            ],
            'endDate': datetime(2015, 1, 1),
            'supportedServices': [
                'MONITORING'|'PATCHING'|'SECURITY'|'BACKUP_AND_DISASTER_RECOVERY'|'FINANCIAL_OPERATIONS'|'INFRASTRUCTURE_AS_CODE_AND_AUTOMATION'|'WELL_ARCHITECTED'|'ARTIFICIAL_INTELLIGENCE_AND_MACHINE_LEARNING_OPERATIONS',
            ],
            'legalEntityAddress': {
                'city': 'string',
                'stateOrRegion': 'string',
                'postalCode': 'string',
                'countryCode': 'string',
                'addressLine': 'string',
                'addressLine2': 'string'
            },
            'signatoryName': 'string',
            'signatoryEmail': 'string'
        }
    },
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
type contractType:

string

param contractType:

[REQUIRED]

The type of channel contract to create (for example, managed services attestation).

type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier for the channel contract.

type payload:

dict

param payload:

[REQUIRED]

The payload containing specific details for the contract type.

  • managedServicesAttestationPayload (dict) --

    Payload for creating a managed services attestation channel contract. Applies only to managed services attestation channel contracts.

    • legalEntityName (string) -- [REQUIRED]

      The legal name of the end customer's legal entity.

    • relationshipIdentifier (string) -- [REQUIRED]

      The identifier of the managed services relationship to cover with the attestation.

    • programManagementAccountIdentifier (string) -- [REQUIRED]

      The identifier of the program management account for the relationship.

    • memberAccountIds (list) --

      The AWS account IDs of the end customer's member accounts to cover, not allowed when the account scope is the entire organization.

      • (string) --

    • endDate (datetime) -- [REQUIRED]

      The end date of the attestation, which must be after the start date of the relationship.

    • supportedServices (list) -- [REQUIRED]

      The managed services that the partner provides to the end customer.

      • (string) --

    • legalEntityAddress (dict) -- [REQUIRED]

      The address of the end customer's legal entity.

      • city (string) -- [REQUIRED]

        The city or locality.

      • stateOrRegion (string) -- [REQUIRED]

        The state, province, or prefecture.

      • postalCode (string) -- [REQUIRED]

        The postal code.

      • countryCode (string) -- [REQUIRED]

        The two-letter ISO 3166-1 country code.

      • addressLine (string) -- [REQUIRED]

        The first line of the street address.

      • addressLine2 (string) --

        The second line of the street address.

    • signatoryName (string) -- [REQUIRED]

      The name of the person who signs the attestation for the end customer.

    • signatoryEmail (string) -- [REQUIRED]

      The email address to which the attestation is sent for signature.

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

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

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

Response Structure

  • (dict) --

    • channelContractDetail (dict) --

      Details of the created channel contract.

      • id (string) --

        The unique identifier of the created channel contract.

      • arn (string) --

        The Amazon Resource Name (ARN) of the created channel contract.

ListChannelContracts (new) Link ¶

Lists channel contracts based on specified criteria.

See also: AWS API Documentation

Request Syntax

client.list_channel_contracts(
    catalog='string',
    contractType='MANAGED_SERVICES_ATTESTATION',
    statuses=[
        'PENDING'|'ACCEPTED'|'EXPIRED'|'CANCELED'|'INACTIVE',
    ],
    contractTypeFilters={
        'managedServicesAttestationTypeFilters': {
            'relationshipIdentifiers': [
                'string',
            ],
            'legalEntityNames': [
                'string',
            ]
        }
    },
    contractTypeSort={
        'managedServicesAttestationTypeSort': {
            'sortOrder': 'Ascending'|'Descending',
            'sortBy': 'UpdatedAt'
        }
    },
    maxResults=123,
    nextToken='string'
)
type catalog:

string

param catalog:

[REQUIRED]

The catalog identifier to filter channel contracts.

type contractType:

string

param contractType:

[REQUIRED]

Filter results by contract type.

type statuses:

list

param statuses:

Filter results by channel contract status.

  • (string) --

type contractTypeFilters:

dict

param contractTypeFilters:

Type-specific filters for channel contracts.

  • managedServicesAttestationTypeFilters (dict) --

    Filters specific to managed services attestation channel contracts. Applies only to managed services attestation channel contracts.

    • relationshipIdentifiers (list) --

      Filter by relationship identifiers.

      • (string) --

    • legalEntityNames (list) --

      Filter by legal entity names.

      • (string) --

type contractTypeSort:

dict

param contractTypeSort:

Type-specific sorting options for channel contracts.

  • managedServicesAttestationTypeSort (dict) --

    Sorting options specific to managed services attestation channel contracts. Applies only to managed services attestation channel contracts.

    • sortOrder (string) -- [REQUIRED]

      The sort order (ascending or descending).

    • sortBy (string) -- [REQUIRED]

      The field to sort by.

type maxResults:

integer

param maxResults:

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

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',
            'contractType': 'MANAGED_SERVICES_ATTESTATION',
            'status': 'PENDING'|'ACCEPTED'|'EXPIRED'|'CANCELED'|'INACTIVE',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'respondedAt': datetime(2015, 1, 1),
            'details': {
                'managedServicesAttestationDetails': {
                    'legalEntityName': 'string',
                    'relationshipIdentifier': 'string',
                    'programManagementAccountIdentifier': 'string',
                    'memberAccountIds': [
                        'string',
                    ],
                    'endDate': datetime(2015, 1, 1),
                    'supportedServices': [
                        'MONITORING'|'PATCHING'|'SECURITY'|'BACKUP_AND_DISASTER_RECOVERY'|'FINANCIAL_OPERATIONS'|'INFRASTRUCTURE_AS_CODE_AND_AUTOMATION'|'WELL_ARCHITECTED'|'ARTIFICIAL_INTELLIGENCE_AND_MACHINE_LEARNING_OPERATIONS',
                    ]
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      List of channel contracts matching the criteria.

      • (dict) --

        Summary information about a channel contract.

        • id (string) --

          The unique identifier of the channel contract.

        • arn (string) --

          The Amazon Resource Name (ARN) of the channel contract.

        • catalog (string) --

          The catalog identifier associated with the channel contract.

        • contractType (string) --

          The type of the channel contract.

        • status (string) --

          The current status of the channel contract.

        • createdAt (datetime) --

          The timestamp when the channel contract was created.

        • updatedAt (datetime) --

          The timestamp when the channel contract was last updated.

        • respondedAt (datetime) --

          The timestamp when the channel contract was accepted, if applicable.

        • details (dict) --

          Type-specific summary details of the channel contract.

          • managedServicesAttestationDetails (dict) --

            Summary details specific to managed services attestation channel contracts. Applies only to managed services attestation channel contracts.

            • legalEntityName (string) --

              The legal name of the end customer's legal entity.

            • relationshipIdentifier (string) --

              The identifier of the relationship covered by the attestation.

            • programManagementAccountIdentifier (string) --

              The identifier of the program management account.

            • memberAccountIds (list) --

              The AWS account IDs of the end customer's member accounts covered by the managed services.

              • (string) --

            • endDate (datetime) --

              The end date of the managed services attestation.

            • supportedServices (list) --

              The managed services that the partner provides to the end customer.

              • (string) --

    • nextToken (string) --

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

CreateProgramManagementAccount (updated) Link ¶
Changes (request)
{'program': {'MANAGED_SERVICES_PROVIDER'},
 'type': 'RESALE_BILLING_TRANSFER | MANAGED_SERVICES'}

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'|'MANAGED_SERVICES_PROVIDER',
    displayName='string',
    accountId='string',
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    type='RESALE_BILLING_TRANSFER'|'MANAGED_SERVICES'
)
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.

type type:

string

param type:

The type of the program management account (for example, resale billing transfer, managed services), required for the managed services provider program.

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.

CreateRelationship (updated) Link ¶
Changes (request)
{'accountScope': 'ENTIRE_ORGANIZATION | SPECIFIC_MEMBER_ACCOUNTS',
 'associationType': {'MANAGED_SERVICES_END_CUSTOMER'},
 'startDate': 'timestamp'}

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'|'MANAGED_SERVICES_END_CUSTOMER',
    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={
        'resoldEnterprise': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY',
            'tamLocation': 'string',
            'chargeAccountId': 'string'
        },
        'partnerLedSupport': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY',
            'provider': 'DISTRIBUTOR'|'DISTRIBUTION_SELLER',
            'tamLocation': 'string'
        },
        'resoldUnifiedOperations': {
            'coverage': 'ENTIRE_ORGANIZATION'|'MANAGEMENT_ACCOUNT_ONLY',
            'tamLocation': 'string',
            'chargeAccountId': 'string'
        }
    },
    accountScope='ENTIRE_ORGANIZATION'|'SPECIFIC_MEMBER_ACCOUNTS',
    startDate=datetime(2015, 1, 1)
)
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:

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. Applies only to billing transfer relationships.

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. Applies only to billing transfer relationships.

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

  • resoldUnifiedOperations (dict) --

    Configuration for resold unified operations support plans.

    • coverage (string) -- [REQUIRED]

      The coverage level for resold unified operations support.

    • tamLocation (string) -- [REQUIRED]

      The location of the Technical Account Manager (TAM).

    • chargeAccountId (string) --

      The AWS account ID to charge for the support plan.

type accountScope:

string

param accountScope:

The account scope for a managed services relationship (for example, entire organization, specific member accounts). Applies only to managed services relationships.

type startDate:

datetime

param startDate:

The start date of the managed services relationship. Applies only to managed services relationships.

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.

GetRelationship (updated) Link ¶
Changes (response)
{'relationshipDetail': {'accountScope': 'ENTIRE_ORGANIZATION | '
                                        'SPECIFIC_MEMBER_ACCOUNTS',
                        'associationType': {'MANAGED_SERVICES_END_CUSTOMER'},
                        'channelContractId': 'string',
                        'endDate': 'timestamp'}}

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'|'MANAGED_SERVICES_END_CUSTOMER',
        'programManagementAccountId': 'string',
        'associatedAccountId': 'string',
        'displayName': 'string',
        'resaleAccountModel': 'DISTRIBUTOR'|'END_CUSTOMER'|'SOLUTION_PROVIDER',
        'sector': 'COMMERCIAL'|'GOVERNMENT'|'GOVERNMENT_EXCEPTION',
        'accountScope': 'ENTIRE_ORGANIZATION'|'SPECIFIC_MEMBER_ACCOUNTS',
        'channelContractId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'startDate': datetime(2015, 1, 1),
        'endDate': 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. Applies only to billing transfer relationships.

      • sector (string) --

        The business sector for the relationship.

      • accountScope (string) --

        The account scope of the managed services relationship. Applies only to managed services relationships.

      • channelContractId (string) --

        The identifier of the channel contract currently in effect for the relationship. Applies only to managed services relationships.

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

      • endDate (datetime) --

        The end date of the relationship.

ListChannelHandshakes (updated) Link ¶
Changes (request, response)
Request
{'handshakeTypeFilters': {'programManagementAccountTypeFilters': {'programs': {'MANAGED_SERVICES_PROVIDER'}}}}
Response
{'items': {'detail': {'programManagementAccountHandshakeDetail': {'program': {'MANAGED_SERVICES_PROVIDER'}}}}}

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

ListProgramManagementAccounts (updated) Link ¶
Changes (request, response)
Request
{'programs': {'MANAGED_SERVICES_PROVIDER'},
 'type': 'RESALE_BILLING_TRANSFER | MANAGED_SERVICES'}
Response
{'items': {'program': {'MANAGED_SERVICES_PROVIDER'},
           'type': 'RESALE_BILLING_TRANSFER | MANAGED_SERVICES'}}

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'|'MANAGED_SERVICES_PROVIDER',
    ],
    accountIds=[
        'string',
    ],
    statuses=[
        'PENDING'|'ACTIVE'|'INACTIVE',
    ],
    sort={
        'sortOrder': 'Ascending'|'Descending',
        'sortBy': 'UpdatedAt'
    },
    nextToken='string',
    type='RESALE_BILLING_TRANSFER'|'MANAGED_SERVICES'
)
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.

type type:

string

param type:

Filter by program management account type.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'revision': 'string',
            'catalog': 'string',
            'program': 'SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER'|'MANAGED_SERVICES_PROVIDER',
            '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',
            'type': 'RESALE_BILLING_TRANSFER'|'MANAGED_SERVICES'
        },
    ],
    '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.

        • type (string) --

          The type of the program management account.

    • nextToken (string) --

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

ListRelationships (updated) Link ¶
Changes (request, response)
Request
{'associationTypes': {'MANAGED_SERVICES_END_CUSTOMER'}}
Response
{'items': {'associationType': {'MANAGED_SERVICES_END_CUSTOMER'}}}

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'|'MANAGED_SERVICES_END_CUSTOMER',
    ],
    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'|'MANAGED_SERVICES_END_CUSTOMER',
            '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.