PartnerCentralBenefits / Client / amend_benefit_application

amend_benefit_application

PartnerCentralBenefits.Client.amend_benefit_application(**kwargs)

Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.

See also: AWS API Documentation

Request Syntax

response = client.amend_benefit_application(
    Catalog='string',
    ClientToken='string',
    Revision='string',
    Identifier='string',
    AmendmentReason='string',
    Amendments=[
        {
            'FieldPath': 'string',
            'NewValue': '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 amendment request.

• Revision (string) –

  [REQUIRED]

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

• Identifier (string) –

  [REQUIRED]

  The unique identifier of the benefit application to be amended.

• AmendmentReason (string) –

  [REQUIRED]

  A descriptive reason explaining why the benefit application is being amended.

• Amendments (list) –

  [REQUIRED]

  A list of specific field amendments to apply to the benefit application.

  • (dict) –

    Represents a specific change to be made to a benefit application field.

    • FieldPath (string) – [REQUIRED]

      The JSON path or field identifier specifying which field in the benefit application to modify.

    • NewValue (string) – [REQUIRED]

      The new value to set for the specified field in the benefit application.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• PartnerCentralBenefits.Client.exceptions.ValidationException

• PartnerCentralBenefits.Client.exceptions.AccessDeniedException

• PartnerCentralBenefits.Client.exceptions.InternalServerException

• PartnerCentralBenefits.Client.exceptions.ConflictException

• PartnerCentralBenefits.Client.exceptions.ThrottlingException

• PartnerCentralBenefits.Client.exceptions.ResourceNotFoundException