PartnerCentralAccountAPI / Client / cancel_profile_update_task

cancel_profile_update_task

PartnerCentralAccountAPI.Client.cancel_profile_update_task(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier for the partner account.

• Identifier (string) –

  [REQUIRED]

  The unique identifier of the partner account.

• ClientToken (string) –

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

  This field is autopopulated if not provided.

• TaskId (string) –

  [REQUIRED]

  The unique identifier of the profile update task to cancel.

Return type:

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.

Exceptions

• PartnerCentralAccountAPI.Client.exceptions.ResourceNotFoundException

• PartnerCentralAccountAPI.Client.exceptions.AccessDeniedException

• PartnerCentralAccountAPI.Client.exceptions.ConflictException

• PartnerCentralAccountAPI.Client.exceptions.ThrottlingException

• PartnerCentralAccountAPI.Client.exceptions.ValidationException

• PartnerCentralAccountAPI.Client.exceptions.InternalServerException