PartnerCentralBenefits / Client / get_benefit_application

get_benefit_application

PartnerCentralBenefits.Client.get_benefit_application(**kwargs)

Retrieves detailed information about a specific benefit application.

See also: AWS API Documentation

Request Syntax

response = client.get_benefit_application(
    Catalog='string',
    Identifier='string'
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier that specifies which benefit catalog to query.

• Identifier (string) –

  [REQUIRED]

  The unique identifier of the benefit application to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'Catalog': 'string',
    'BenefitId': 'string',
    'Name': 'string',
    'Description': 'string',
    'FulfillmentTypes': [
        'CREDITS'|'CASH'|'ACCESS',
    ],
    'BenefitApplicationDetails': {...}|[...]|123|123.4|'string'|True|None,
    'Programs': [
        'string',
    ],
    'Status': 'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
    'Stage': 'string',
    'StatusReason': 'string',
    'StatusReasonCode': 'string',
    'StatusReasonCodes': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'Revision': 'string',
    'AssociatedResources': [
        'string',
    ],
    'PartnerContacts': [
        {
            'Email': 'string',
            'FirstName': 'string',
            'LastName': 'string',
            'BusinessTitle': 'string',
            'Phone': 'string'
        },
    ],
    'FileDetails': [
        {
            'FileURI': 'string',
            'BusinessUseCase': 'string',
            'FileName': 'string',
            'FileStatus': 'string',
            'FileStatusReason': 'string',
            'FileType': 'application/msword'|'application/vnd.openxmlformats-officedocument.wordprocessingml.document'|'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'|'application/vnd.openxmlformats-officedocument.presentationml.presentation'|'application/pdf'|'image/png'|'image/jpeg'|'image/svg+xml'|'text/csv',
            'CreatedBy': 'string',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • Id (string) –

    The unique identifier of the benefit application.

  • Arn (string) –

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

  • Catalog (string) –

    The catalog identifier that the benefit application belongs to.

  • BenefitId (string) –

    The identifier of the benefit being requested in this application.

  • Name (string) –

    The human-readable name of the benefit application.

  • Description (string) –

    A detailed description of the benefit application.

  • FulfillmentTypes (list) –

    The fulfillment types requested for this benefit application.

    • (string) –

  • BenefitApplicationDetails (document) –

    Detailed information and requirements specific to the benefit being requested.

  • Programs (list) –

    The AWS partner programs associated with this benefit application.

    • (string) –

  • Status (string) –

    The current processing status of the benefit application.

  • Stage (string) –

    The current stage in the benefit application processing workflow.

  • StatusReason (string) –

    Additional information explaining the current status of the benefit application.

  • StatusReasonCode (string) –

    A standardized code representing the reason for the current status.

  • StatusReasonCodes (list) –

    The list of standardized codes representing the reason for the current status.

    • (string) –

  • CreatedAt (datetime) –

    The timestamp when the benefit application was created.

  • UpdatedAt (datetime) –

    The timestamp when the benefit application was last updated.

  • Revision (string) –

    The current revision number of the benefit application.

  • AssociatedResources (list) –

    AWS resources that are associated with this benefit application.

    • (string) –

  • PartnerContacts (list) –

    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) –

    Supporting documents and files attached to the benefit application.

    • (dict) –

      Represents detailed information about a file attached to a benefit application.

      • FileURI (string) –

        The URI or location where the file is stored.

      • BusinessUseCase (string) –

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

      • FileName (string) –

        The original name of the uploaded file.

      • FileStatus (string) –

        The current processing status of the file (e.g., uploaded, processing, approved, rejected).

      • FileStatusReason (string) –

        The reason for that particulat file status.

      • FileType (string) –

        The type or category of the file (e.g., document, image, spreadsheet).

      • CreatedBy (string) –

        The identifier of the user who uploaded the file.

      • CreatedAt (datetime) –

        The timestamp when the file was uploaded.

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