PartnerCentralBenefits / Client / list_benefit_applications

list_benefit_applications

PartnerCentralBenefits.Client.list_benefit_applications(**kwargs)

Retrieves a paginated list of benefit applications based on specified filter criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_benefit_applications(
    Catalog='string',
    Programs=[
        'string',
    ],
    FulfillmentTypes=[
        'CREDITS'|'CASH'|'ACCESS',
    ],
    BenefitIdentifiers=[
        'string',
    ],
    Status=[
        'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
    ],
    Stages=[
        'string',
    ],
    AssociatedResources=[
        {
            'ResourceType': 'OPPORTUNITY'|'BENEFIT_ALLOCATION',
            'ResourceIdentifier': 'string',
            'ResourceArn': 'string'
        },
    ],
    AssociatedResourceArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier to filter benefit applications by catalog.

• Programs (list) –

  Filter benefit applications by specific AWS partner programs.

  • (string) –

• FulfillmentTypes (list) –

  Filter benefit applications by specific fulfillment types.

  • (string) –

• BenefitIdentifiers (list) –

  Filter benefit applications by specific benefit identifiers.

  • (string) –

• Status (list) –

  Filter benefit applications by their current processing status.

  • (string) –

• Stages (list) –

  Filter benefit applications by their current processing stage.

  • (string) –

• AssociatedResources (list) –

  Filter benefit applications by associated AWS resources.

  • (dict) –

    Represents an AWS resource that is associated with a benefit application for tracking and management.

    • ResourceType (string) –

      The type of AWS resource (e.g., EC2 instance, S3 bucket, Lambda function).

    • ResourceIdentifier (string) –

      The unique identifier of the AWS resource within its service.

    • ResourceArn (string) –

      The Amazon Resource Name (ARN) that uniquely identifies the AWS resource.

• AssociatedResourceArns (list) –

  Filter benefit applications by specific AWS resource ARNs.

  • (string) –

• MaxResults (integer) – The maximum number of benefit applications to return in a single response.

• NextToken (string) – A pagination token to retrieve the next set of results from a previous request.

Return type:

dict

Returns:

Response Syntax

{
    'BenefitApplicationSummaries': [
        {
            'Catalog': 'string',
            'Name': 'string',
            'Id': 'string',
            'Arn': 'string',
            'BenefitId': 'string',
            'Programs': [
                'string',
            ],
            'FulfillmentTypes': [
                'CREDITS'|'CASH'|'ACCESS',
            ],
            'Status': 'PENDING_SUBMISSION'|'IN_REVIEW'|'ACTION_REQUIRED'|'APPROVED'|'REJECTED'|'CANCELED',
            'Stage': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'BenefitApplicationDetails': {
                'string': 'string'
            },
            'AssociatedResources': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • BenefitApplicationSummaries (list) –

    A list of benefit application summaries matching the specified criteria.

    • (dict) –

      A summary view of a benefit application containing key information for list operations.

      • Catalog (string) –

        The catalog identifier that the benefit application belongs to.

      • Name (string) –

        The human-readable name of the benefit application.

      • Id (string) –

        The unique identifier of the benefit application.

      • Arn (string) –

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

      • BenefitId (string) –

        The identifier of the benefit being requested in this application.

      • Programs (list) –

        The AWS partner programs associated with this benefit application.

        • (string) –

      • FulfillmentTypes (list) –

        The fulfillment types requested for 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..

      • CreatedAt (datetime) –

        The timestamp when the benefit application was created.

      • UpdatedAt (datetime) –

        The timestamp when the benefit application was last updated.

      • BenefitApplicationDetails (dict) –

        Additional attributes and metadata associated with the benefit application.

        • (string) –

          • (string) –

      • AssociatedResources (list) –

        AWS resources that are associated with this benefit application.

        • (string) –

  • NextToken (string) –

    A pagination token to retrieve the next set of results, if more results are available.

Exceptions

• PartnerCentralBenefits.Client.exceptions.ValidationException

• PartnerCentralBenefits.Client.exceptions.AccessDeniedException

• PartnerCentralBenefits.Client.exceptions.InternalServerException

• PartnerCentralBenefits.Client.exceptions.ThrottlingException

• PartnerCentralBenefits.Client.exceptions.ResourceNotFoundException