PartnerCentralBenefits / Client / get_benefit

get_benefit

PartnerCentralBenefits.Client.get_benefit(**kwargs)

Retrieves detailed information about a specific benefit available in the partner catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_benefit(
    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 to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Catalog': 'string',
    'Arn': 'string',
    'Name': 'string',
    'Description': 'string',
    'Programs': [
        'string',
    ],
    'FulfillmentTypes': [
        'CREDITS'|'CASH'|'ACCESS',
    ],
    'BenefitRequestSchema': {...}|[...]|123|123.4|'string'|True|None,
    'Status': 'ACTIVE'|'INACTIVE'
}

Response Structure

• (dict) –

  • Id (string) –

    The unique identifier of the benefit.

  • Catalog (string) –

    The catalog identifier that the benefit belongs to.

  • Arn (string) –

    The Amazon Resource Name (ARN) of the benefit.

  • Name (string) –

    The human-readable name of the benefit.

  • Description (string) –

    A detailed description of the benefit and its purpose.

  • Programs (list) –

    The AWS partner programs that this benefit is associated with.

    • (string) –

  • FulfillmentTypes (list) –

    The available fulfillment types for this benefit (e.g., credits, access, disbursement).

    • (string) –

  • BenefitRequestSchema (document) –

    The schema definition that describes the required fields for requesting this benefit.

  • Status (string) –

    The current status of the benefit (e.g., active, inactive, deprecated).

Exceptions

• PartnerCentralBenefits.Client.exceptions.ValidationException

• PartnerCentralBenefits.Client.exceptions.AccessDeniedException

• PartnerCentralBenefits.Client.exceptions.InternalServerException

• PartnerCentralBenefits.Client.exceptions.ThrottlingException

• PartnerCentralBenefits.Client.exceptions.ResourceNotFoundException