Partner Central Account API

Creates a new partner account in the AWS Partner Network with the specified details and configuration.

See also: AWS API Documentation

Request Syntax

client.create_partner(
    Catalog='string',
    ClientToken='string',
    LegalName='string',
    PrimarySolutionType='SOFTWARE_PRODUCTS'|'CONSULTING_SERVICES'|'PROFESSIONAL_SERVICES'|'MANAGED_SERVICES'|'HARDWARE_PRODUCTS'|'COMMUNICATION_SERVICES'|'VALUE_ADDED_RESALE_AWS_SERVICES'|'TRAINING_SERVICES',
    AllianceLeadContact={
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'BusinessTitle': 'string'
    },
    EmailVerificationCode='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the partner account will be created.

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type LegalName:

string

param LegalName:

[REQUIRED]

The legal name of the organization becoming a partner.

type PrimarySolutionType:

string

param PrimarySolutionType:

[REQUIRED]

The primary type of solution or service the partner provides (e.g., consulting, software, managed services).

type AllianceLeadContact:

dict

param AllianceLeadContact:

[REQUIRED]

The primary contact person for alliance and partnership matters.

• FirstName (string) -- [REQUIRED]

  The first name of the alliance lead contact person.

• LastName (string) -- [REQUIRED]

  The last name of the alliance lead contact person.

• Email (string) -- [REQUIRED]

  The email address of the alliance lead contact person.

• BusinessTitle (string) -- [REQUIRED]

  The business title or role of the alliance lead contact person.

type EmailVerificationCode:

string

param EmailVerificationCode:

[REQUIRED]

The verification code sent to the alliance lead contact's email to confirm account creation.

type Tags:

list

param Tags:

A list of tags to associate with the partner account for organization and billing purposes.

• (dict) --

  A key-value pair used to associate metadata with AWS Partner Central Account resources.

  • Key (string) -- [REQUIRED]

    The key name of the tag. Tag keys are case-sensitive.

  • Value (string) -- [REQUIRED]

    The value associated with the tag key. Tag values are case-sensitive.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'LegalName': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Profile': {
        'DisplayName': 'string',
        'Description': 'string',
        'WebsiteUrl': 'string',
        'LogoUrl': 'string',
        'PrimarySolutionType': 'SOFTWARE_PRODUCTS'|'CONSULTING_SERVICES'|'PROFESSIONAL_SERVICES'|'MANAGED_SERVICES'|'HARDWARE_PRODUCTS'|'COMMUNICATION_SERVICES'|'VALUE_ADDED_RESALE_AWS_SERVICES'|'TRAINING_SERVICES',
        'IndustrySegments': [
            'AGRICULTURE_MINING'|'BIOTECHNOLOGY'|'BUSINESS_CONSUMER_SERVICES'|'BUSINESS_SERV'|'COMMUNICATIONS'|'COMPUTER_HARDWARE'|'COMPUTERS_ELECTRONICS'|'COMPUTER_SOFTWARE'|'CONSUMER_GOODS'|'CONSUMER_RELATED'|'EDUCATION'|'ENERGY_UTILITIES'|'FINANCIAL_SERVICES'|'GAMING'|'GOVERNMENT'|'GOVERNMENT_EDUCATION_PUBLIC_SERVICES'|'HEALTHCARE'|'HEALTHCARE_PHARMACEUTICALS_BIOTECH'|'INDUSTRIAL_ENERGY'|'INTERNET_SPECIFIC'|'LIFE_SCIENCES'|'MANUFACTURING'|'MEDIA_ENTERTAINMENT_LEISURE'|'MEDIA_ENTERTAINMENT'|'MEDICAL_HEALTH'|'NON_PROFIT_ORGANIZATION'|'OTHER'|'PROFESSIONAL_SERVICES'|'REAL_ESTATE_CONSTRUCTION'|'RETAIL'|'RETAIL_WHOLESALE_DISTRIBUTION'|'SEMICONDUCTOR_ELECTR'|'SOFTWARE_INTERNET'|'TELECOMMUNICATIONS'|'TRANSPORTATION_LOGISTICS'|'TRAVEL_HOSPITALITY'|'WHOLESALE_DISTRIBUTION',
        ],
        'TranslationSourceLocale': 'string',
        'LocalizedContents': [
            {
                'DisplayName': 'string',
                'Description': 'string',
                'WebsiteUrl': 'string',
                'LogoUrl': 'string',
                'Locale': 'string'
            },
        ],
        'ProfileId': 'string'
    },
    'AwsTrainingCertificationEmailDomains': [
        {
            'DomainName': 'string',
            'RegisteredAt': datetime(2015, 1, 1)
        },
    ],
    'AllianceLeadContact': {
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'BusinessTitle': 'string'
    }
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier where the partner account was created.

  • Arn (string) --

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

  • Id (string) --

    The unique identifier of the created partner account.

  • LegalName (string) --

    The legal name of the partner organization.

  • CreatedAt (datetime) --

    The timestamp when the partner account was created.

  • Profile (dict) --

    The partner profile information including display name, description, and other public details.

    • DisplayName (string) --

      The public display name for the partner organization.

    • Description (string) --

      A description of the partner's business, services, and capabilities.

    • WebsiteUrl (string) --

      The partner's primary website URL.

    • LogoUrl (string) --

      The URL to the partner's logo image.

    • PrimarySolutionType (string) --

      The primary type of solution or service the partner provides.

    • IndustrySegments (list) --

      The industry segments or verticals that the partner serves.

      • (string) --

    • TranslationSourceLocale (string) --

      The source locale used for automatic translation of profile content.

    • LocalizedContents (list) --

      A list of localized content versions for different languages and regions.

      • (dict) --

        Contains localized content for a partner profile in a specific language or locale.

        • DisplayName (string) --

          The localized display name for the partner.

        • Description (string) --

          The localized description of the partner's business and services.

        • WebsiteUrl (string) --

          The localized website URL for the partner.

        • LogoUrl (string) --

          The URL to the partner's logo image for this locale.

        • Locale (string) --

          The locale or language code for the localized content.

    • ProfileId (string) --

      The unique identifier of the partner profile.

  • AwsTrainingCertificationEmailDomains (list) --

    The list of verified email domains associated with AWS training and certification credentials for the partner organization.

    • (dict) --

      Represents a verified domain associated with a partner account.

      • DomainName (string) --

        The domain name that has been verified for the partner account.

      • RegisteredAt (datetime) --

        The timestamp when the domain was registered and verified for the partner account.

  • AllianceLeadContact (dict) --

    The alliance lead contact information for the partner account.

    • FirstName (string) --

      The first name of the alliance lead contact person.

    • LastName (string) --

      The last name of the alliance lead contact person.

    • Email (string) --

      The email address of the alliance lead contact person.

    • BusinessTitle (string) --

      The business title or role of the alliance lead contact person.

Sets the visibility level for a partner profile, controlling who can view the profile information.

See also: AWS API Documentation

Request Syntax

client.put_profile_visibility(
    Catalog='string',
    Identifier='string',
    Visibility='PRIVATE'|'PUBLIC'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

type Visibility:

string

param Visibility:

[REQUIRED]

The visibility setting to apply to the partner profile.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'Visibility': 'PRIVATE'|'PUBLIC',
    'ProfileId': 'string'
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the partner account.

  • Id (string) --

    The unique identifier of the partner account.

  • Visibility (string) --

    The updated visibility setting for the partner profile.

  • ProfileId (string) --

    The unique identifier of the partner profile.

Lists partner accounts in the catalog, providing a summary view of all partners.

See also: AWS API Documentation

Request Syntax

client.list_partners(
    Catalog='string',
    NextToken='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier to list partners from.

type NextToken:

string

param NextToken:

The token for retrieving the next page of results in paginated responses.

rtype:

dict

returns:

Response Syntax

{
    'PartnerSummaryList': [
        {
            'Catalog': 'string',
            'Arn': 'string',
            'Id': 'string',
            'LegalName': 'string',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • PartnerSummaryList (list) --

    A list of partner summaries including basic information about each partner account.

    • (dict) --

      A summary view of a partner account containing basic information for listing purposes.

      • Catalog (string) --

        The catalog identifier for the partner account.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the partner account.

      • Id (string) --

        The unique identifier of the partner account.

      • LegalName (string) --

        The legal name of the partner organization.

      • CreatedAt (datetime) --

        The timestamp when the partner account was created.

  • NextToken (string) --

    The token for retrieving the next page of results if more results are available.

Creates or updates the alliance lead contact information for a partner account.

See also: AWS API Documentation

Request Syntax

client.put_alliance_lead_contact(
    Catalog='string',
    Identifier='string',
    AllianceLeadContact={
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'BusinessTitle': 'string'
    },
    EmailVerificationCode='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

type AllianceLeadContact:

dict

param AllianceLeadContact:

[REQUIRED]

The alliance lead contact information to set for the partner account.

• FirstName (string) -- [REQUIRED]

  The first name of the alliance lead contact person.

• LastName (string) -- [REQUIRED]

  The last name of the alliance lead contact person.

• Email (string) -- [REQUIRED]

  The email address of the alliance lead contact person.

• BusinessTitle (string) -- [REQUIRED]

  The business title or role of the alliance lead contact person.

type EmailVerificationCode:

string

param EmailVerificationCode:

The verification code sent to the alliance lead contact's email to confirm the update.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'AllianceLeadContact': {
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'BusinessTitle': 'string'
    }
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the partner account.

  • Id (string) --

    The unique identifier of the partner account.

  • AllianceLeadContact (dict) --

    The updated alliance lead contact information.

    • FirstName (string) --

      The first name of the alliance lead contact person.

    • LastName (string) --

      The last name of the alliance lead contact person.

    • Email (string) --

      The email address of the alliance lead contact person.

    • BusinessTitle (string) --

      The business title or role of the alliance lead contact person.

Updates the connection preferences for a partner account, modifying access settings and exclusions.

See also: AWS API Documentation

Request Syntax

client.update_connection_preferences(
    Catalog='string',
    Revision=123,
    AccessType='ALLOW_ALL'|'DENY_ALL'|'ALLOW_BY_DEFAULT_DENY_SOME',
    ExcludedParticipantIdentifiers=[
        'string',
    ]
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Revision:

integer

param Revision:

[REQUIRED]

The revision number of the connection preferences for optimistic locking.

type AccessType:

string

param AccessType:

[REQUIRED]

The access type setting for connections (e.g., open, restricted, invitation-only).

type ExcludedParticipantIdentifiers:

list

param ExcludedParticipantIdentifiers:

The updated list of participant identifiers to exclude from connections.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'AccessType': 'ALLOW_ALL'|'DENY_ALL'|'ALLOW_BY_DEFAULT_DENY_SOME',
    'ExcludedParticipantIds': [
        'string',
    ],
    'UpdatedAt': datetime(2015, 1, 1),
    'Revision': 123
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the updated connection preferences.

  • AccessType (string) --

    The updated access type setting for connections.

  • ExcludedParticipantIds (list) --

    A list of participant IDs that are excluded from connection requests or interactions.

    • (string) --

  • UpdatedAt (datetime) --

    The timestamp when the connection preferences were last updated.

  • Revision (integer) --

    The updated revision number of the connection preferences.

Retrieves detailed information about a specific connection invitation.

See also: AWS API Documentation

Request Syntax

client.get_connection_invitation(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the connection invitation exists.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the connection invitation to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Id': 'string',
    'Arn': 'string',
    'ConnectionId': 'string',
    'ConnectionType': 'OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'ExpiresAt': datetime(2015, 1, 1),
    'OtherParticipantIdentifier': 'string',
    'ParticipantType': 'SENDER'|'RECEIVER',
    'Status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED',
    'InvitationMessage': 'string',
    'InviterEmail': 'string',
    'InviterName': 'string'
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier where the connection invitation exists.

  • Id (string) --

    The unique identifier of the connection invitation.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the connection invitation.

  • ConnectionId (string) --

    The identifier of the connection associated with this invitation.

  • ConnectionType (string) --

    The type of connection being requested in the invitation.

  • CreatedAt (datetime) --

    The timestamp when the connection invitation was created.

  • UpdatedAt (datetime) --

    The timestamp when the connection invitation was last updated.

  • ExpiresAt (datetime) --

    The timestamp when the connection invitation will expire.

  • OtherParticipantIdentifier (string) --

    The identifier of the other participant in the connection invitation.

  • ParticipantType (string) --

    The type of participant (inviter or invitee) in the connection invitation.

  • Status (string) --

    The current status of the connection invitation.

  • InvitationMessage (string) --

    The custom message included with the connection invitation.

  • InviterEmail (string) --

    The email address of the person who sent the connection invitation.

  • InviterName (string) --

    The name of the person who sent the connection invitation.

Lists all tags associated with a specific AWS Partner Central Account 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

{
    'ResourceArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • ResourceArn (string) --

    The Amazon Resource Name (ARN) of the resource that the tags are associated with.

  • Tags (list) --

    A list of tags associated with the specified resource.

    • (dict) --

      A key-value pair used to associate metadata with AWS Partner Central Account resources.

      • Key (string) --

        The key name of the tag. Tag keys are case-sensitive.

      • Value (string) --

        The value associated with the tag key. Tag values are case-sensitive.

Retrieves the alliance lead contact information for a partner account.

See also: AWS API Documentation

Request Syntax

client.get_alliance_lead_contact(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'AllianceLeadContact': {
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'BusinessTitle': 'string'
    }
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the partner account.

  • Id (string) --

    The unique identifier of the partner account.

  • AllianceLeadContact (dict) --

    The alliance lead contact information including name, email, and business title.

    • FirstName (string) --

      The first name of the alliance lead contact person.

    • LastName (string) --

      The last name of the alliance lead contact person.

    • Email (string) --

      The email address of the alliance lead contact person.

    • BusinessTitle (string) --

      The business title or role of the alliance lead contact person.

Retrieves information about a specific profile update task.

See also: AWS API Documentation

Request Syntax

client.get_profile_update_task(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'TaskId': 'string',
    'TaskDetails': {
        'DisplayName': 'string',
        'Description': 'string',
        'WebsiteUrl': 'string',
        'LogoUrl': 'string',
        'PrimarySolutionType': 'SOFTWARE_PRODUCTS'|'CONSULTING_SERVICES'|'PROFESSIONAL_SERVICES'|'MANAGED_SERVICES'|'HARDWARE_PRODUCTS'|'COMMUNICATION_SERVICES'|'VALUE_ADDED_RESALE_AWS_SERVICES'|'TRAINING_SERVICES',
        'IndustrySegments': [
            'AGRICULTURE_MINING'|'BIOTECHNOLOGY'|'BUSINESS_CONSUMER_SERVICES'|'BUSINESS_SERV'|'COMMUNICATIONS'|'COMPUTER_HARDWARE'|'COMPUTERS_ELECTRONICS'|'COMPUTER_SOFTWARE'|'CONSUMER_GOODS'|'CONSUMER_RELATED'|'EDUCATION'|'ENERGY_UTILITIES'|'FINANCIAL_SERVICES'|'GAMING'|'GOVERNMENT'|'GOVERNMENT_EDUCATION_PUBLIC_SERVICES'|'HEALTHCARE'|'HEALTHCARE_PHARMACEUTICALS_BIOTECH'|'INDUSTRIAL_ENERGY'|'INTERNET_SPECIFIC'|'LIFE_SCIENCES'|'MANUFACTURING'|'MEDIA_ENTERTAINMENT_LEISURE'|'MEDIA_ENTERTAINMENT'|'MEDICAL_HEALTH'|'NON_PROFIT_ORGANIZATION'|'OTHER'|'PROFESSIONAL_SERVICES'|'REAL_ESTATE_CONSTRUCTION'|'RETAIL'|'RETAIL_WHOLESALE_DISTRIBUTION'|'SEMICONDUCTOR_ELECTR'|'SOFTWARE_INTERNET'|'TELECOMMUNICATIONS'|'TRANSPORTATION_LOGISTICS'|'TRAVEL_HOSPITALITY'|'WHOLESALE_DISTRIBUTION',
        ],
        'TranslationSourceLocale': 'string',
        'LocalizedContents': [
            {
                'DisplayName': 'string',
                'Description': 'string',
                'WebsiteUrl': 'string',
                'LogoUrl': 'string',
                'Locale': 'string'
            },
        ]
    },
    'StartedAt': datetime(2015, 1, 1),
    'Status': 'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED',
    'EndedAt': datetime(2015, 1, 1),
    'ErrorDetailList': [
        {
            'Locale': 'string',
            'Message': 'string',
            'Reason': 'INVALID_CONTENT'|'DUPLICATE_PROFILE'|'INVALID_LOGO'|'INVALID_LOGO_URL'|'INVALID_LOGO_FILE'|'INVALID_LOGO_SIZE'|'INVALID_WEBSITE_URL'
        },
    ]
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the profile update task.

  • Id (string) --

    The unique identifier of the partner account.

  • TaskId (string) --

    The unique identifier of the profile update task.

  • TaskDetails (dict) --

    The details of the profile update task including what changes are being made.

    • DisplayName (string) --

      The updated display name for the partner profile.

    • Description (string) --

      The updated description for the partner profile.

    • WebsiteUrl (string) --

      The updated website URL for the partner profile.

    • LogoUrl (string) --

      The updated logo URL for the partner profile.

    • PrimarySolutionType (string) --

      The updated primary solution type for the partner profile.

    • IndustrySegments (list) --

      The updated industry segments for the partner profile.

      • (string) --

    • TranslationSourceLocale (string) --

      The updated translation source locale for the partner profile.

    • LocalizedContents (list) --

      The updated localized content for the partner profile.

      • (dict) --

        Contains localized content for a partner profile in a specific language or locale.

        • DisplayName (string) --

          The localized display name for the partner.

        • Description (string) --

          The localized description of the partner's business and services.

        • WebsiteUrl (string) --

          The localized website URL for the partner.

        • LogoUrl (string) --

          The URL to the partner's logo image for this locale.

        • Locale (string) --

          The locale or language code for the localized content.

  • StartedAt (datetime) --

    The timestamp when the profile update task was started.

  • Status (string) --

    The current status of the profile update task (in progress, completed, failed, etc.).

  • EndedAt (datetime) --

    The timestamp when the profile update task was completed or failed.

  • ErrorDetailList (list) --

    A list of error details if any errors occurred during the profile update task.

    • (dict) --

      Contains detailed information about an error that occurred during an operation.

      • Locale (string) --

        The locale or language code for the error message.

      • Message (string) --

        A human-readable description of the error.

      • Reason (string) --

        A machine-readable code or reason for the error.

Retrieves detailed information about a specific connection between partners.

See also: AWS API Documentation

Request Syntax

client.get_connection(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the connection exists.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the connection to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Id': 'string',
    'Arn': 'string',
    'OtherParticipantAccountId': 'string',
    'UpdatedAt': datetime(2015, 1, 1),
    'ConnectionTypes': {
        'string': {
            'CreatedAt': datetime(2015, 1, 1),
            'InviterEmail': 'string',
            'InviterName': 'string',
            'Status': 'ACTIVE'|'CANCELED',
            'CanceledAt': datetime(2015, 1, 1),
            'CanceledBy': 'string',
            'OtherParticipant': {
                'PartnerProfile': {
                    'Id': 'string',
                    'Name': 'string'
                },
                'SellerProfile': {
                    'Id': 'string',
                    'Name': 'string'
                },
                'Account': {
                    'Name': 'string'
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier where the connection exists.

  • Id (string) --

    The unique identifier of the connection.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the connection.

  • OtherParticipantAccountId (string) --

    The AWS account ID of the other participant in the connection.

  • UpdatedAt (datetime) --

    The timestamp when the connection was last updated.

  • ConnectionTypes (dict) --

    The list of connection types active between the partners.

    • (string) --

      • (dict) --

        Detailed information about a specific connection type within a connection.

        • CreatedAt (datetime) --

          The timestamp when this connection type was created.

        • InviterEmail (string) --

          The email address of the person who initiated this connection type.

        • InviterName (string) --

          The name of the person who initiated this connection type.

        • Status (string) --

          The current status of this connection type.

        • CanceledAt (datetime) --

          The timestamp when this connection type was cancelled, if applicable.

        • CanceledBy (string) --

          The AWS account ID of the participant who cancelled this connection type.

        • OtherParticipant (dict) --

          Information about the other participant in this connection type.

          • PartnerProfile (dict) --

            The partner profile information for the participant.

            • Id (string) --

              The unique identifier of the partner profile.

            • Name (string) --

              The display name of the partner.

          • SellerProfile (dict) --

            The seller profile information for the participant.

            • Id (string) --

              The unique identifier of the seller profile.

            • Name (string) --

              The display name of the seller.

          • Account (dict) --

            The AWS account information for the participant.

            • Name (string) --

              The name associated with the AWS account.

Retrieves the connection preferences for a partner account, including access settings and exclusions.

See also: AWS API Documentation

Request Syntax

client.get_connection_preferences(
    Catalog='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'AccessType': 'ALLOW_ALL'|'DENY_ALL'|'ALLOW_BY_DEFAULT_DENY_SOME',
    'ExcludedParticipantIds': [
        'string',
    ],
    'UpdatedAt': datetime(2015, 1, 1),
    'Revision': 123
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the connection preferences.

  • AccessType (string) --

    The access type setting for connections (e.g., open, restricted, invitation-only).

  • ExcludedParticipantIds (list) --

    A list of participant IDs that are excluded from connection requests or interactions.

    • (string) --

  • UpdatedAt (datetime) --

    The timestamp when the connection preferences were last updated.

  • Revision (integer) --

    The revision number of the connection preferences for optimistic locking.

Associates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.

See also: AWS API Documentation

Request Syntax

client.associate_aws_training_certification_email_domain(
    Catalog='string',
    Identifier='string',
    ClientToken='string',
    Email='string',
    EmailVerificationCode='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type Email:

string

param Email:

[REQUIRED]

The email address used to verify domain ownership for AWS training and certification association.

type EmailVerificationCode:

string

param EmailVerificationCode:

[REQUIRED]

The verification code sent to the email address to confirm domain ownership.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Sends an email verification code to the specified email address for account verification purposes.

See also: AWS API Documentation

Request Syntax

client.send_email_verification_code(
    Catalog='string',
    Email='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Email:

string

param Email:

[REQUIRED]

The email address to send the verification code to.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Cancels an existing connection between partners, terminating the partnership relationship.

See also: AWS API Documentation

Request Syntax

client.cancel_connection(
    Catalog='string',
    Identifier='string',
    ConnectionType='OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    Reason='string',
    ClientToken='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the connection exists.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the connection to cancel.

type ConnectionType:

string

param ConnectionType:

[REQUIRED]

The type of connection to cancel (e.g., reseller, distributor, technology partner).

type Reason:

string

param Reason:

[REQUIRED]

The reason for canceling the connection, providing context for the termination.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Id': 'string',
    'Arn': 'string',
    'OtherParticipantAccountId': 'string',
    'UpdatedAt': datetime(2015, 1, 1),
    'ConnectionTypes': {
        'string': {
            'CreatedAt': datetime(2015, 1, 1),
            'InviterEmail': 'string',
            'InviterName': 'string',
            'Status': 'ACTIVE'|'CANCELED',
            'CanceledAt': datetime(2015, 1, 1),
            'CanceledBy': 'string',
            'OtherParticipant': {
                'PartnerProfile': {
                    'Id': 'string',
                    'Name': 'string'
                },
                'SellerProfile': {
                    'Id': 'string',
                    'Name': 'string'
                },
                'Account': {
                    'Name': 'string'
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier where the connection was canceled.

  • Id (string) --

    The unique identifier of the canceled connection.

  • Arn (string) --

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

  • OtherParticipantAccountId (string) --

    The AWS account ID of the other participant in the canceled connection.

  • UpdatedAt (datetime) --

    The timestamp when the connection was last updated (canceled).

  • ConnectionTypes (dict) --

    The list of connection types that were active before cancellation.

    • (string) --

      • (dict) --

        Detailed information about a specific connection type within a connection.

        • CreatedAt (datetime) --

          The timestamp when this connection type was created.

        • InviterEmail (string) --

          The email address of the person who initiated this connection type.

        • InviterName (string) --

          The name of the person who initiated this connection type.

        • Status (string) --

          The current status of this connection type.

        • CanceledAt (datetime) --

          The timestamp when this connection type was cancelled, if applicable.

        • CanceledBy (string) --

          The AWS account ID of the participant who cancelled this connection type.

        • OtherParticipant (dict) --

          Information about the other participant in this connection type.

          • PartnerProfile (dict) --

            The partner profile information for the participant.

            • Id (string) --

              The unique identifier of the partner profile.

            • Name (string) --

              The display name of the partner.

          • SellerProfile (dict) --

            The seller profile information for the participant.

            • Id (string) --

              The unique identifier of the seller profile.

            • Name (string) --

              The display name of the seller.

          • Account (dict) --

            The AWS account information for the participant.

            • Name (string) --

              The name associated with the AWS account.

Initiates a profile update task to modify partner profile information asynchronously.

See also: AWS API Documentation

Request Syntax

client.start_profile_update_task(
    Catalog='string',
    Identifier='string',
    ClientToken='string',
    TaskDetails={
        'DisplayName': 'string',
        'Description': 'string',
        'WebsiteUrl': 'string',
        'LogoUrl': 'string',
        'PrimarySolutionType': 'SOFTWARE_PRODUCTS'|'CONSULTING_SERVICES'|'PROFESSIONAL_SERVICES'|'MANAGED_SERVICES'|'HARDWARE_PRODUCTS'|'COMMUNICATION_SERVICES'|'VALUE_ADDED_RESALE_AWS_SERVICES'|'TRAINING_SERVICES',
        'IndustrySegments': [
            'AGRICULTURE_MINING'|'BIOTECHNOLOGY'|'BUSINESS_CONSUMER_SERVICES'|'BUSINESS_SERV'|'COMMUNICATIONS'|'COMPUTER_HARDWARE'|'COMPUTERS_ELECTRONICS'|'COMPUTER_SOFTWARE'|'CONSUMER_GOODS'|'CONSUMER_RELATED'|'EDUCATION'|'ENERGY_UTILITIES'|'FINANCIAL_SERVICES'|'GAMING'|'GOVERNMENT'|'GOVERNMENT_EDUCATION_PUBLIC_SERVICES'|'HEALTHCARE'|'HEALTHCARE_PHARMACEUTICALS_BIOTECH'|'INDUSTRIAL_ENERGY'|'INTERNET_SPECIFIC'|'LIFE_SCIENCES'|'MANUFACTURING'|'MEDIA_ENTERTAINMENT_LEISURE'|'MEDIA_ENTERTAINMENT'|'MEDICAL_HEALTH'|'NON_PROFIT_ORGANIZATION'|'OTHER'|'PROFESSIONAL_SERVICES'|'REAL_ESTATE_CONSTRUCTION'|'RETAIL'|'RETAIL_WHOLESALE_DISTRIBUTION'|'SEMICONDUCTOR_ELECTR'|'SOFTWARE_INTERNET'|'TELECOMMUNICATIONS'|'TRANSPORTATION_LOGISTICS'|'TRAVEL_HOSPITALITY'|'WHOLESALE_DISTRIBUTION',
        ],
        'TranslationSourceLocale': 'string',
        'LocalizedContents': [
            {
                'DisplayName': 'string',
                'Description': 'string',
                'WebsiteUrl': 'string',
                'LogoUrl': 'string',
                'Locale': 'string'
            },
        ]
    }
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type TaskDetails:

dict

param TaskDetails:

[REQUIRED]

The details of the profile updates to be performed.

• DisplayName (string) -- [REQUIRED]

  The updated display name for the partner profile.

• Description (string) -- [REQUIRED]

  The updated description for the partner profile.

• WebsiteUrl (string) -- [REQUIRED]

  The updated website URL for the partner profile.

• LogoUrl (string) -- [REQUIRED]

  The updated logo URL for the partner profile.

• PrimarySolutionType (string) -- [REQUIRED]

  The updated primary solution type for the partner profile.

• IndustrySegments (list) -- [REQUIRED]

  The updated industry segments for the partner profile.

  • (string) --

• TranslationSourceLocale (string) -- [REQUIRED]

  The updated translation source locale for the partner profile.

• LocalizedContents (list) --

  The updated localized content for the partner profile.

  • (dict) --

    Contains localized content for a partner profile in a specific language or locale.

    • DisplayName (string) -- [REQUIRED]

      The localized display name for the partner.

    • Description (string) -- [REQUIRED]

      The localized description of the partner's business and services.

    • WebsiteUrl (string) -- [REQUIRED]

      The localized website URL for the partner.

    • LogoUrl (string) -- [REQUIRED]

      The URL to the partner's logo image for this locale.

    • Locale (string) -- [REQUIRED]

      The locale or language code for the localized content.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'TaskId': 'string',
    'TaskDetails': {
        'DisplayName': 'string',
        'Description': 'string',
        'WebsiteUrl': 'string',
        'LogoUrl': 'string',
        'PrimarySolutionType': 'SOFTWARE_PRODUCTS'|'CONSULTING_SERVICES'|'PROFESSIONAL_SERVICES'|'MANAGED_SERVICES'|'HARDWARE_PRODUCTS'|'COMMUNICATION_SERVICES'|'VALUE_ADDED_RESALE_AWS_SERVICES'|'TRAINING_SERVICES',
        'IndustrySegments': [
            'AGRICULTURE_MINING'|'BIOTECHNOLOGY'|'BUSINESS_CONSUMER_SERVICES'|'BUSINESS_SERV'|'COMMUNICATIONS'|'COMPUTER_HARDWARE'|'COMPUTERS_ELECTRONICS'|'COMPUTER_SOFTWARE'|'CONSUMER_GOODS'|'CONSUMER_RELATED'|'EDUCATION'|'ENERGY_UTILITIES'|'FINANCIAL_SERVICES'|'GAMING'|'GOVERNMENT'|'GOVERNMENT_EDUCATION_PUBLIC_SERVICES'|'HEALTHCARE'|'HEALTHCARE_PHARMACEUTICALS_BIOTECH'|'INDUSTRIAL_ENERGY'|'INTERNET_SPECIFIC'|'LIFE_SCIENCES'|'MANUFACTURING'|'MEDIA_ENTERTAINMENT_LEISURE'|'MEDIA_ENTERTAINMENT'|'MEDICAL_HEALTH'|'NON_PROFIT_ORGANIZATION'|'OTHER'|'PROFESSIONAL_SERVICES'|'REAL_ESTATE_CONSTRUCTION'|'RETAIL'|'RETAIL_WHOLESALE_DISTRIBUTION'|'SEMICONDUCTOR_ELECTR'|'SOFTWARE_INTERNET'|'TELECOMMUNICATIONS'|'TRANSPORTATION_LOGISTICS'|'TRAVEL_HOSPITALITY'|'WHOLESALE_DISTRIBUTION',
        ],
        'TranslationSourceLocale': 'string',
        'LocalizedContents': [
            {
                'DisplayName': 'string',
                'Description': 'string',
                'WebsiteUrl': 'string',
                'LogoUrl': 'string',
                'Locale': 'string'
            },
        ]
    },
    'StartedAt': datetime(2015, 1, 1),
    'Status': 'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED',
    'EndedAt': datetime(2015, 1, 1),
    'ErrorDetailList': [
        {
            'Locale': 'string',
            'Message': 'string',
            'Reason': 'INVALID_CONTENT'|'DUPLICATE_PROFILE'|'INVALID_LOGO'|'INVALID_LOGO_URL'|'INVALID_LOGO_FILE'|'INVALID_LOGO_SIZE'|'INVALID_WEBSITE_URL'
        },
    ]
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the started profile update task.

  • Id (string) --

    The unique identifier of the partner account.

  • TaskId (string) --

    The unique identifier of the started profile update task.

  • TaskDetails (dict) --

    The details of the profile update task that was started.

    • DisplayName (string) --

      The updated display name for the partner profile.

    • Description (string) --

      The updated description for the partner profile.

    • WebsiteUrl (string) --

      The updated website URL for the partner profile.

    • LogoUrl (string) --

      The updated logo URL for the partner profile.

    • PrimarySolutionType (string) --

      The updated primary solution type for the partner profile.

    • IndustrySegments (list) --

      The updated industry segments for the partner profile.

      • (string) --

    • TranslationSourceLocale (string) --

      The updated translation source locale for the partner profile.

    • LocalizedContents (list) --

      The updated localized content for the partner profile.

      • (dict) --

        Contains localized content for a partner profile in a specific language or locale.

        • DisplayName (string) --

          The localized display name for the partner.

        • Description (string) --

          The localized description of the partner's business and services.

        • WebsiteUrl (string) --

          The localized website URL for the partner.

        • LogoUrl (string) --

          The URL to the partner's logo image for this locale.

        • Locale (string) --

          The locale or language code for the localized content.

  • StartedAt (datetime) --

    The timestamp when the profile update task was started.

  • Status (string) --

    The current status of the profile update task (in progress).

  • EndedAt (datetime) --

    The timestamp when the profile update task ended (null for in-progress tasks).

  • ErrorDetailList (list) --

    A list of error details if any errors occurred during the profile update task.

    • (dict) --

      Contains detailed information about an error that occurred during an operation.

      • Locale (string) --

        The locale or language code for the error message.

      • Message (string) --

        A human-readable description of the error.

      • Reason (string) --

        A machine-readable code or reason for the error.

Removes the association between an email domain and AWS training and certification for the partner account.

See also: AWS API Documentation

Request Syntax

client.disassociate_aws_training_certification_email_domain(
    Catalog='string',
    Identifier='string',
    ClientToken='string',
    DomainName='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type DomainName:

string

param DomainName:

[REQUIRED]

The domain name to disassociate from AWS training and certification.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Adds or updates tags for a specified AWS Partner Central Account 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]

A list of tags to add or update for the specified resource.

• (dict) --

  A key-value pair used to associate metadata with AWS Partner Central Account resources.

  • Key (string) -- [REQUIRED]

    The key name of the tag. Tag keys are case-sensitive.

  • Value (string) -- [REQUIRED]

    The value associated with the tag key. Tag values are case-sensitive.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Removes specified tags from an AWS Partner Central Account 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]

A list of tag keys to remove from the specified resource.

• (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Creates a new connection invitation to establish a partnership with another organization.

See also: AWS API Documentation

Request Syntax

client.create_connection_invitation(
    Catalog='string',
    ClientToken='string',
    ConnectionType='OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    Email='string',
    Message='string',
    Name='string',
    ReceiverIdentifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the connection invitation will be created.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

This field is autopopulated if not provided.

type ConnectionType:

string

param ConnectionType:

[REQUIRED]

The type of connection being requested (e.g., reseller, distributor, technology partner).

type Email:

string

param Email:

[REQUIRED]

The email address of the person to send the connection invitation to.

type Message:

string

param Message:

[REQUIRED]

A custom message to include with the connection invitation.

type Name:

string

param Name:

[REQUIRED]

The name of the person sending the connection invitation.

type ReceiverIdentifier:

string

param ReceiverIdentifier:

[REQUIRED]

The identifier of the organization or partner to invite for connection.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Id': 'string',
    'Arn': 'string',
    'ConnectionId': 'string',
    'ConnectionType': 'OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'ExpiresAt': datetime(2015, 1, 1),
    'OtherParticipantIdentifier': 'string',
    'ParticipantType': 'SENDER'|'RECEIVER',
    'Status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED',
    'InvitationMessage': 'string',
    'InviterEmail': 'string',
    'InviterName': 'string'
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier where the connection invitation was created.

  • Id (string) --

    The unique identifier of the created connection invitation.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the created connection invitation.

  • ConnectionId (string) --

    The identifier of the connection associated with this invitation.

  • ConnectionType (string) --

    The type of connection being requested in the invitation.

  • CreatedAt (datetime) --

    The timestamp when the connection invitation was created.

  • UpdatedAt (datetime) --

    The timestamp when the connection invitation was last updated.

  • ExpiresAt (datetime) --

    The timestamp when the connection invitation will expire if not responded to.

  • OtherParticipantIdentifier (string) --

    The identifier of the organization or partner being invited.

  • ParticipantType (string) --

    The type of participant (inviter or invitee) in the connection invitation.

  • Status (string) --

    The current status of the connection invitation (pending, accepted, rejected, etc.).

  • InvitationMessage (string) --

    The custom message included with the connection invitation.

  • InviterEmail (string) --

    The email address of the person who sent the connection invitation.

  • InviterName (string) --

    The name of the person who sent the connection invitation.

Cancels a pending connection invitation before it has been accepted or rejected.

See also: AWS API Documentation

Request Syntax

client.cancel_connection_invitation(
    Catalog='string',
    Identifier='string',
    ClientToken='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the connection invitation exists.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the connection invitation to cancel.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Id': 'string',
    'Arn': 'string',
    'ConnectionId': 'string',
    'ConnectionType': 'OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'ExpiresAt': datetime(2015, 1, 1),
    'OtherParticipantIdentifier': 'string',
    'ParticipantType': 'SENDER'|'RECEIVER',
    'Status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED',
    'InvitationMessage': 'string',
    'InviterEmail': 'string',
    'InviterName': 'string'
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier where the connection invitation was canceled.

  • Id (string) --

    The unique identifier of the canceled connection invitation.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the canceled connection invitation.

  • ConnectionId (string) --

    The identifier of the connection associated with the canceled invitation.

  • ConnectionType (string) --

    The type of connection that was being invited for.

  • CreatedAt (datetime) --

    The timestamp when the connection invitation was originally created.

  • UpdatedAt (datetime) --

    The timestamp when the connection invitation was last updated (canceled).

  • ExpiresAt (datetime) --

    The timestamp when the connection invitation would have expired if not canceled.

  • OtherParticipantIdentifier (string) --

    The identifier of the other participant who was invited to connect.

  • ParticipantType (string) --

    The type of participant (inviter or invitee) in the connection invitation.

  • Status (string) --

    The current status of the connection invitation (canceled).

  • InvitationMessage (string) --

    The message that was included with the original connection invitation.

  • InviterEmail (string) --

    The email address of the person who sent the connection invitation.

  • InviterName (string) --

    The name of the person who sent the connection invitation.

Lists active connections for the partner account, with optional filtering by connection type and participant.

See also: AWS API Documentation

Request Syntax

client.list_connections(
    Catalog='string',
    NextToken='string',
    ConnectionType='string',
    MaxResults=123,
    OtherParticipantIdentifiers=[
        'string',
    ]
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type NextToken:

string

param NextToken:

The token for retrieving the next page of results in paginated responses.

type ConnectionType:

string

param ConnectionType:

Filter results by connection type (e.g., reseller, distributor, technology partner).

type MaxResults:

integer

param MaxResults:

The maximum number of connections to return in a single response.

type OtherParticipantIdentifiers:

list

param OtherParticipantIdentifiers:

Filter results by specific participant identifiers.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'ConnectionSummaries': [
        {
            'Catalog': 'string',
            'Id': 'string',
            'Arn': 'string',
            'OtherParticipantAccountId': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'ConnectionTypes': {
                'string': {
                    'Status': 'ACTIVE'|'CANCELED',
                    'OtherParticipant': {
                        'PartnerProfile': {
                            'Id': 'string',
                            'Name': 'string'
                        },
                        'SellerProfile': {
                            'Id': 'string',
                            'Name': 'string'
                        },
                        'Account': {
                            'Name': 'string'
                        }
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ConnectionSummaries (list) --

    A list of connection summaries matching the specified criteria.

    • (dict) --

      A summary view of an active connection between partners containing key information.

      • Catalog (string) --

        The catalog identifier where the connection exists.

      • Id (string) --

        The unique identifier of the connection.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the connection.

      • OtherParticipantAccountId (string) --

        The AWS account ID of the other participant in the connection.

      • UpdatedAt (datetime) --

        The timestamp when the connection was last updated.

      • ConnectionTypes (dict) --

        A map of connection types and their summary information for this connection.

        • (string) --

          • (dict) --

            Summary information about a specific connection type between partners.

            • Status (string) --

              The current status of this connection type (active, canceled, etc.).

            • OtherParticipant (dict) --

              Information about the other participant in this connection type.

              • PartnerProfile (dict) --

                The partner profile information for the participant.

                • Id (string) --

                  The unique identifier of the partner profile.

                • Name (string) --

                  The display name of the partner.

              • SellerProfile (dict) --

                The seller profile information for the participant.

                • Id (string) --

                  The unique identifier of the seller profile.

                • Name (string) --

                  The display name of the seller.

              • Account (dict) --

                The AWS account information for the participant.

                • Name (string) --

                  The name associated with the AWS account.

  • NextToken (string) --

    The token for retrieving the next page of results if more results are available.

Retrieves detailed information about a specific partner account.

See also: AWS API Documentation

Request Syntax

client.get_partner(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'LegalName': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Profile': {
        'DisplayName': 'string',
        'Description': 'string',
        'WebsiteUrl': 'string',
        'LogoUrl': 'string',
        'PrimarySolutionType': 'SOFTWARE_PRODUCTS'|'CONSULTING_SERVICES'|'PROFESSIONAL_SERVICES'|'MANAGED_SERVICES'|'HARDWARE_PRODUCTS'|'COMMUNICATION_SERVICES'|'VALUE_ADDED_RESALE_AWS_SERVICES'|'TRAINING_SERVICES',
        'IndustrySegments': [
            'AGRICULTURE_MINING'|'BIOTECHNOLOGY'|'BUSINESS_CONSUMER_SERVICES'|'BUSINESS_SERV'|'COMMUNICATIONS'|'COMPUTER_HARDWARE'|'COMPUTERS_ELECTRONICS'|'COMPUTER_SOFTWARE'|'CONSUMER_GOODS'|'CONSUMER_RELATED'|'EDUCATION'|'ENERGY_UTILITIES'|'FINANCIAL_SERVICES'|'GAMING'|'GOVERNMENT'|'GOVERNMENT_EDUCATION_PUBLIC_SERVICES'|'HEALTHCARE'|'HEALTHCARE_PHARMACEUTICALS_BIOTECH'|'INDUSTRIAL_ENERGY'|'INTERNET_SPECIFIC'|'LIFE_SCIENCES'|'MANUFACTURING'|'MEDIA_ENTERTAINMENT_LEISURE'|'MEDIA_ENTERTAINMENT'|'MEDICAL_HEALTH'|'NON_PROFIT_ORGANIZATION'|'OTHER'|'PROFESSIONAL_SERVICES'|'REAL_ESTATE_CONSTRUCTION'|'RETAIL'|'RETAIL_WHOLESALE_DISTRIBUTION'|'SEMICONDUCTOR_ELECTR'|'SOFTWARE_INTERNET'|'TELECOMMUNICATIONS'|'TRANSPORTATION_LOGISTICS'|'TRAVEL_HOSPITALITY'|'WHOLESALE_DISTRIBUTION',
        ],
        'TranslationSourceLocale': 'string',
        'LocalizedContents': [
            {
                'DisplayName': 'string',
                'Description': 'string',
                'WebsiteUrl': 'string',
                'LogoUrl': 'string',
                'Locale': 'string'
            },
        ],
        'ProfileId': 'string'
    },
    'AwsTrainingCertificationEmailDomains': [
        {
            'DomainName': 'string',
            'RegisteredAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the partner account.

  • Id (string) --

    The unique identifier of the partner account.

  • LegalName (string) --

    The legal name of the partner organization.

  • CreatedAt (datetime) --

    The timestamp when the partner account was created.

  • Profile (dict) --

    The partner profile information including display name, description, and other public details.

    • DisplayName (string) --

      The public display name for the partner organization.

    • Description (string) --

      A description of the partner's business, services, and capabilities.

    • WebsiteUrl (string) --

      The partner's primary website URL.

    • LogoUrl (string) --

      The URL to the partner's logo image.

    • PrimarySolutionType (string) --

      The primary type of solution or service the partner provides.

    • IndustrySegments (list) --

      The industry segments or verticals that the partner serves.

      • (string) --

    • TranslationSourceLocale (string) --

      The source locale used for automatic translation of profile content.

    • LocalizedContents (list) --

      A list of localized content versions for different languages and regions.

      • (dict) --

        Contains localized content for a partner profile in a specific language or locale.

        • DisplayName (string) --

          The localized display name for the partner.

        • Description (string) --

          The localized description of the partner's business and services.

        • WebsiteUrl (string) --

          The localized website URL for the partner.

        • LogoUrl (string) --

          The URL to the partner's logo image for this locale.

        • Locale (string) --

          The locale or language code for the localized content.

    • ProfileId (string) --

      The unique identifier of the partner profile.

  • AwsTrainingCertificationEmailDomains (list) --

    The list of verified email domains associated with AWS training and certification credentials for the partner organization.

    • (dict) --

      Represents a verified domain associated with a partner account.

      • DomainName (string) --

        The domain name that has been verified for the partner account.

      • RegisteredAt (datetime) --

        The timestamp when the domain was registered and verified for the partner account.

Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.

See also: AWS API Documentation

Request Syntax

client.list_connection_invitations(
    Catalog='string',
    NextToken='string',
    ConnectionType='OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    MaxResults=123,
    OtherParticipantIdentifiers=[
        'string',
    ],
    ParticipantType='SENDER'|'RECEIVER',
    Status='PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type NextToken:

string

param NextToken:

The token for retrieving the next page of results in paginated responses.

type ConnectionType:

string

param ConnectionType:

Filter results by connection type (e.g., reseller, distributor, technology partner).

type MaxResults:

integer

param MaxResults:

The maximum number of connection invitations to return in a single response.

type OtherParticipantIdentifiers:

list

param OtherParticipantIdentifiers:

Filter results by specific participant identifiers.

• (string) --

type ParticipantType:

string

param ParticipantType:

Filter results by participant type (inviter or invitee).

type Status:

string

param Status:

Filter results by invitation status (pending, accepted, rejected, canceled, expired).

rtype:

dict

returns:

Response Syntax

{
    'ConnectionInvitationSummaries': [
        {
            'Catalog': 'string',
            'Id': 'string',
            'Arn': 'string',
            'ConnectionId': 'string',
            'ConnectionType': 'OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'ExpiresAt': datetime(2015, 1, 1),
            'OtherParticipantIdentifier': 'string',
            'ParticipantType': 'SENDER'|'RECEIVER',
            'Status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ConnectionInvitationSummaries (list) --

    A list of connection invitation summaries matching the specified criteria.

    • (dict) --

      A summary view of a connection invitation containing key information without full details.

      • Catalog (string) --

        The catalog identifier where the connection invitation exists.

      • Id (string) --

        The unique identifier of the connection invitation.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the connection invitation.

      • ConnectionId (string) --

        The identifier of the connection associated with this invitation.

      • ConnectionType (string) --

        The type of connection being requested in the invitation.

      • CreatedAt (datetime) --

        The timestamp when the connection invitation was created.

      • UpdatedAt (datetime) --

        The timestamp when the connection invitation was last updated.

      • ExpiresAt (datetime) --

        The timestamp when the connection invitation will expire.

      • OtherParticipantIdentifier (string) --

        The identifier of the other participant in the connection invitation.

      • ParticipantType (string) --

        The type of participant (inviter or invitee) in the connection invitation.

      • Status (string) --

        The current status of the connection invitation.

  • NextToken (string) --

    The token for retrieving the next page of results if more results are available.

Rejects a connection invitation from another partner, declining the partnership request.

See also: AWS API Documentation

Request Syntax

client.reject_connection_invitation(
    Catalog='string',
    Identifier='string',
    ClientToken='string',
    Reason='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the connection invitation exists.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the connection invitation to reject.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

This field is autopopulated if not provided.

type Reason:

string

param Reason:

The reason for rejecting the connection invitation.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Id': 'string',
    'Arn': 'string',
    'ConnectionId': 'string',
    'ConnectionType': 'OPPORTUNITY_COLLABORATION'|'SUBSIDIARY',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'ExpiresAt': datetime(2015, 1, 1),
    'OtherParticipantIdentifier': 'string',
    'ParticipantType': 'SENDER'|'RECEIVER',
    'Status': 'PENDING'|'ACCEPTED'|'REJECTED'|'CANCELED'|'EXPIRED',
    'InvitationMessage': 'string',
    'InviterEmail': 'string',
    'InviterName': 'string'
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier where the connection invitation was rejected.

  • Id (string) --

    The unique identifier of the rejected connection invitation.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the rejected connection invitation.

  • ConnectionId (string) --

    The identifier of the connection associated with the rejected invitation.

  • ConnectionType (string) --

    The type of connection that was being invited for.

  • CreatedAt (datetime) --

    The timestamp when the connection invitation was originally created.

  • UpdatedAt (datetime) --

    The timestamp when the connection invitation was last updated (rejected).

  • ExpiresAt (datetime) --

    The timestamp when the connection invitation would have expired.

  • OtherParticipantIdentifier (string) --

    The identifier of the other participant who sent the invitation.

  • ParticipantType (string) --

    The type of participant (inviter or invitee) in the connection invitation.

  • Status (string) --

    The current status of the connection invitation (rejected).

  • InvitationMessage (string) --

    The message that was included with the original connection invitation.

  • InviterEmail (string) --

    The email address of the person who sent the connection invitation.

  • InviterName (string) --

    The name of the person who sent the connection invitation.

Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.

See also: AWS API Documentation

Request Syntax

client.accept_connection_invitation(
    Catalog='string',
    Identifier='string',
    ClientToken='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier where the connection invitation exists.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the connection invitation to accept.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Connection': {
        'Catalog': 'string',
        'Id': 'string',
        'Arn': 'string',
        'OtherParticipantAccountId': 'string',
        'UpdatedAt': datetime(2015, 1, 1),
        'ConnectionTypes': {
            'string': {
                'CreatedAt': datetime(2015, 1, 1),
                'InviterEmail': 'string',
                'InviterName': 'string',
                'Status': 'ACTIVE'|'CANCELED',
                'CanceledAt': datetime(2015, 1, 1),
                'CanceledBy': 'string',
                'OtherParticipant': {
                    'PartnerProfile': {
                        'Id': 'string',
                        'Name': 'string'
                    },
                    'SellerProfile': {
                        'Id': 'string',
                        'Name': 'string'
                    },
                    'Account': {
                        'Name': 'string'
                    }
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • Connection (dict) --

    The details of the accepted connection between the two partners.

    • Catalog (string) --

      The catalog identifier that the connection belongs to.

    • Id (string) --

      The unique identifier of the connection.

    • Arn (string) --

      The AWS Resource Name (ARN) of the connection.

    • OtherParticipantAccountId (string) --

      The AWS account ID of the other participant in the connection.

    • UpdatedAt (datetime) --

      The timestamp when the connection was last updated.

    • ConnectionTypes (dict) --

      The type of connection.

      • (string) --

        • (dict) --

          Detailed information about a specific connection type within a connection.

          • CreatedAt (datetime) --

            The timestamp when this connection type was created.

          • InviterEmail (string) --

            The email address of the person who initiated this connection type.

          • InviterName (string) --

            The name of the person who initiated this connection type.

          • Status (string) --

            The current status of this connection type.

          • CanceledAt (datetime) --

            The timestamp when this connection type was cancelled, if applicable.

          • CanceledBy (string) --

            The AWS account ID of the participant who cancelled this connection type.

          • OtherParticipant (dict) --

            Information about the other participant in this connection type.

            • PartnerProfile (dict) --

              The partner profile information for the participant.

              • Id (string) --

                The unique identifier of the partner profile.

              • Name (string) --

                The display name of the partner.

            • SellerProfile (dict) --

              The seller profile information for the participant.

              • Id (string) --

                The unique identifier of the seller profile.

              • Name (string) --

                The display name of the seller.

            • Account (dict) --

              The AWS account information for the participant.

              • Name (string) --

                The name associated with the AWS account.

Retrieves the visibility settings for a partner profile, determining who can see the profile information.

See also: AWS API Documentation

Request Syntax

client.get_profile_visibility(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'Visibility': 'PRIVATE'|'PUBLIC',
    'ProfileId': 'string'
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the partner account.

  • Id (string) --

    The unique identifier of the partner account.

  • Visibility (string) --

    The visibility setting for the partner profile (public, private, restricted, etc.).

  • ProfileId (string) --

    The unique identifier of the partner profile.

Cancels an in-progress profile update task, stopping any pending changes to the partner profile.

See also: AWS API Documentation

Request Syntax

client.cancel_profile_update_task(
    Catalog='string',
    Identifier='string',
    ClientToken='string',
    TaskId='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

The catalog identifier for the partner account.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the partner account.

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type TaskId:

string

param TaskId:

[REQUIRED]

The unique identifier of the profile update task to cancel.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'Id': 'string',
    'TaskId': 'string',
    'TaskDetails': {
        'DisplayName': 'string',
        'Description': 'string',
        'WebsiteUrl': 'string',
        'LogoUrl': 'string',
        'PrimarySolutionType': 'SOFTWARE_PRODUCTS'|'CONSULTING_SERVICES'|'PROFESSIONAL_SERVICES'|'MANAGED_SERVICES'|'HARDWARE_PRODUCTS'|'COMMUNICATION_SERVICES'|'VALUE_ADDED_RESALE_AWS_SERVICES'|'TRAINING_SERVICES',
        'IndustrySegments': [
            'AGRICULTURE_MINING'|'BIOTECHNOLOGY'|'BUSINESS_CONSUMER_SERVICES'|'BUSINESS_SERV'|'COMMUNICATIONS'|'COMPUTER_HARDWARE'|'COMPUTERS_ELECTRONICS'|'COMPUTER_SOFTWARE'|'CONSUMER_GOODS'|'CONSUMER_RELATED'|'EDUCATION'|'ENERGY_UTILITIES'|'FINANCIAL_SERVICES'|'GAMING'|'GOVERNMENT'|'GOVERNMENT_EDUCATION_PUBLIC_SERVICES'|'HEALTHCARE'|'HEALTHCARE_PHARMACEUTICALS_BIOTECH'|'INDUSTRIAL_ENERGY'|'INTERNET_SPECIFIC'|'LIFE_SCIENCES'|'MANUFACTURING'|'MEDIA_ENTERTAINMENT_LEISURE'|'MEDIA_ENTERTAINMENT'|'MEDICAL_HEALTH'|'NON_PROFIT_ORGANIZATION'|'OTHER'|'PROFESSIONAL_SERVICES'|'REAL_ESTATE_CONSTRUCTION'|'RETAIL'|'RETAIL_WHOLESALE_DISTRIBUTION'|'SEMICONDUCTOR_ELECTR'|'SOFTWARE_INTERNET'|'TELECOMMUNICATIONS'|'TRANSPORTATION_LOGISTICS'|'TRAVEL_HOSPITALITY'|'WHOLESALE_DISTRIBUTION',
        ],
        'TranslationSourceLocale': 'string',
        'LocalizedContents': [
            {
                'DisplayName': 'string',
                'Description': 'string',
                'WebsiteUrl': 'string',
                'LogoUrl': 'string',
                'Locale': 'string'
            },
        ]
    },
    'StartedAt': datetime(2015, 1, 1),
    'Status': 'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED',
    'EndedAt': datetime(2015, 1, 1),
    'ErrorDetailList': [
        {
            'Locale': 'string',
            'Message': 'string',
            'Reason': 'INVALID_CONTENT'|'DUPLICATE_PROFILE'|'INVALID_LOGO'|'INVALID_LOGO_URL'|'INVALID_LOGO_FILE'|'INVALID_LOGO_SIZE'|'INVALID_WEBSITE_URL'
        },
    ]
}

Response Structure

• (dict) --

  • Catalog (string) --

    The catalog identifier for the partner account.

  • Arn (string) --

    The Amazon Resource Name (ARN) of the canceled profile update task.

  • Id (string) --

    The unique identifier of the partner account.

  • TaskId (string) --

    The unique identifier of the canceled profile update task.

  • TaskDetails (dict) --

    The details of the profile update task that was canceled.

    • DisplayName (string) --

      The updated display name for the partner profile.

    • Description (string) --

      The updated description for the partner profile.

    • WebsiteUrl (string) --

      The updated website URL for the partner profile.

    • LogoUrl (string) --

      The updated logo URL for the partner profile.

    • PrimarySolutionType (string) --

      The updated primary solution type for the partner profile.

    • IndustrySegments (list) --

      The updated industry segments for the partner profile.

      • (string) --

    • TranslationSourceLocale (string) --

      The updated translation source locale for the partner profile.

    • LocalizedContents (list) --

      The updated localized content for the partner profile.

      • (dict) --

        Contains localized content for a partner profile in a specific language or locale.

        • DisplayName (string) --

          The localized display name for the partner.

        • Description (string) --

          The localized description of the partner's business and services.

        • WebsiteUrl (string) --

          The localized website URL for the partner.

        • LogoUrl (string) --

          The URL to the partner's logo image for this locale.

        • Locale (string) --

          The locale or language code for the localized content.

  • StartedAt (datetime) --

    The timestamp when the profile update task was started.

  • Status (string) --

    The current status of the profile update task (canceled).

  • EndedAt (datetime) --

    The timestamp when the profile update task was ended (canceled).

  • ErrorDetailList (list) --

    A list of error details if any errors occurred during the profile update task.

    • (dict) --

      Contains detailed information about an error that occurred during an operation.

      • Locale (string) --

        The locale or language code for the error message.

      • Message (string) --

        A human-readable description of the error.

      • Reason (string) --

        A machine-readable code or reason for the error.