PartnerCentralBenefits / Client / update_benefit_application

update_benefit_application

PartnerCentralBenefits.Client.update_benefit_application(**kwargs)

Updates an existing benefit application with new information while maintaining revision control.

See also: AWS API Documentation

Request Syntax

response = client.update_benefit_application(
    Catalog='string',
    ClientToken='string',
    Name='string',
    Description='string',
    Identifier='string',
    Revision='string',
    BenefitApplicationDetails={...}|[...]|123|123.4|'string'|True|None,
    PartnerContacts=[
        {
            'Email': 'string',
            'FirstName': 'string',
            'LastName': 'string',
            'BusinessTitle': 'string',
            'Phone': 'string'
        },
    ],
    FileDetails=[
        {
            'FileURI': 'string',
            'BusinessUseCase': 'string'
        },
    ]
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier that specifies which benefit catalog the application belongs to.

• ClientToken (string) –

  [REQUIRED]

  A unique, case-sensitive identifier to ensure idempotent processing of the update request.

• Name (string) – The updated human-readable name for the benefit application.

• Description (string) – The updated detailed description of the benefit application.

• Identifier (string) –

  [REQUIRED]

  The unique identifier of the benefit application to update.

• Revision (string) –

  [REQUIRED]

  The current revision number of the benefit application to ensure optimistic concurrency control.

• BenefitApplicationDetails (document) – Updated detailed information and requirements specific to the benefit being requested.

• PartnerContacts (list) –

  Updated contact information for partner representatives responsible for this benefit application.

  • (dict) –

    Represents contact information for a partner representative.

    • Email (string) –

      The email address of the contact person.

    • FirstName (string) –

      The first name of the contact person.

    • LastName (string) –

      The last name of the contact person.

    • BusinessTitle (string) –

      The business title or role of the contact person within the organization.

    • Phone (string) –

      The phone number of the contact person.

• FileDetails (list) –

  Updated supporting documents and files attached to the benefit application.

  • (dict) –

    Represents input information for uploading a file to a benefit application.

    • FileURI (string) – [REQUIRED]

      The URI or location where the file should be stored or has been uploaded.

    • BusinessUseCase (string) –

      The business purpose or use case that this file supports in the benefit application.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Revision': 'string'
}

Response Structure

• (dict) –

  • Id (string) –

    The unique identifier of the updated benefit application.

  • Arn (string) –

    The Amazon Resource Name (ARN) of the updated benefit application.

  • Revision (string) –

    The new revision number of the benefit application after the update.

Exceptions

• PartnerCentralBenefits.Client.exceptions.ValidationException

• PartnerCentralBenefits.Client.exceptions.AccessDeniedException

• PartnerCentralBenefits.Client.exceptions.InternalServerException

• PartnerCentralBenefits.Client.exceptions.ConflictException

• PartnerCentralBenefits.Client.exceptions.ResourceNotFoundException

• PartnerCentralBenefits.Client.exceptions.ThrottlingException