AWS Partner Central Benefits Service provides APIs for managing partner benefits, applications, and allocations within the AWS Partner Network ecosystem.
", "operations": { "AmendBenefitApplication": "Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.
", "AssociateBenefitApplicationResource": "Links an AWS resource to an existing benefit application for tracking and management purposes.
", "CancelBenefitApplication": "Cancels a benefit application that is currently in progress, preventing further processing.
", "CreateBenefitApplication": "Creates a new benefit application for a partner to request access to AWS benefits and programs.
", "DisassociateBenefitApplicationResource": "Removes the association between an AWS resource and a benefit application.
", "GetBenefit": "Retrieves detailed information about a specific benefit available in the partner catalog.
", "GetBenefitAllocation": "Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
", "GetBenefitApplication": "Retrieves detailed information about a specific benefit application.
", "ListBenefitAllocations": "Retrieves a paginated list of benefit allocations based on specified filter criteria.
", "ListBenefitApplications": "Retrieves a paginated list of benefit applications based on specified filter criteria.
", "ListBenefits": "Retrieves a paginated list of available benefits based on specified filter criteria.
", "ListTagsForResource": "Retrieves all tags associated with a specific resource.
", "RecallBenefitApplication": "Recalls a submitted benefit application, returning it to draft status for further modifications.
", "SubmitBenefitApplication": "Submits a benefit application for review and processing by AWS.
", "TagResource": "Adds or updates tags for a specified resource.
", "UntagResource": "Removes specified tags from a resource.
", "UpdateBenefitApplication": "Updates an existing benefit application with new information while maintaining revision control.
" }, "shapes": { "AccessDeniedException": { "base": "Thrown when the caller does not have sufficient permissions to perform the requested operation.
", "refs": {} }, "AccessDetails": { "base": "Contains information about access-based benefit fulfillment, such as service permissions or feature access.
", "refs": { "FulfillmentDetails$AccessDetails": "Details about access-based fulfillment, if applicable to this benefit allocation.
" } }, "AmendBenefitApplicationInput": { "base": null, "refs": {} }, "AmendBenefitApplicationInputAmendmentReasonString": { "base": null, "refs": { "AmendBenefitApplicationInput$AmendmentReason": "A descriptive reason explaining why the benefit application is being amended.
" } }, "AmendBenefitApplicationInputClientTokenString": { "base": null, "refs": { "AmendBenefitApplicationInput$ClientToken": "A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.
" } }, "AmendBenefitApplicationOutput": { "base": null, "refs": {} }, "Amendment": { "base": "Represents a specific change to be made to a benefit application field.
", "refs": { "AmendmentList$member": null } }, "AmendmentList": { "base": null, "refs": { "AmendBenefitApplicationInput$Amendments": "A list of specific field amendments to apply to the benefit application.
" } }, "Arn": { "base": null, "refs": { "Arns$member": null, "AssociatedResource$ResourceArn": "The Amazon Resource Name (ARN) that uniquely identifies the AWS resource.
", "CreateBenefitApplicationInputAssociatedResourcesList$member": null, "GetBenefitApplicationOutput$Arn": "The Amazon Resource Name (ARN) of the benefit application.
", "GetBenefitApplicationOutputAssociatedResourcesList$member": null } }, "Arns": { "base": null, "refs": { "BenefitApplicationSummary$AssociatedResources": "AWS resources that are associated with this benefit application.
", "ListBenefitApplicationsInput$AssociatedResourceArns": "Filter benefit applications by specific AWS resource ARNs.
" } }, "AssociateBenefitApplicationResourceInput": { "base": null, "refs": {} }, "AssociateBenefitApplicationResourceInputResourceArnString": { "base": null, "refs": { "AssociateBenefitApplicationResourceInput$ResourceArn": "The Amazon Resource Name (ARN) of the AWS resource to associate with the benefit application.
" } }, "AssociateBenefitApplicationResourceOutput": { "base": null, "refs": {} }, "AssociatedResource": { "base": "Represents an AWS resource that is associated with a benefit application for tracking and management.
", "refs": { "AssociatedResources$member": null } }, "AssociatedResources": { "base": null, "refs": { "ListBenefitApplicationsInput$AssociatedResources": "Filter benefit applications by associated AWS resources.
" } }, "Attributes": { "base": null, "refs": { "BenefitApplicationSummary$BenefitApplicationDetails": "Additional attributes and metadata associated with the benefit application.
" } }, "BenefitAllocationArn": { "base": null, "refs": { "GetBenefitAllocationOutput$Arn": "The Amazon Resource Name (ARN) of the benefit allocation.
" } }, "BenefitAllocationId": { "base": null, "refs": { "BenefitAllocationSummary$Id": "The unique identifier of the benefit allocation.
", "GetBenefitAllocationOutput$Id": "The unique identifier of the benefit allocation.
" } }, "BenefitAllocationIdentifier": { "base": null, "refs": { "GetBenefitAllocationInput$Identifier": "The unique identifier of the benefit allocation to retrieve.
" } }, "BenefitAllocationName": { "base": null, "refs": { "BenefitAllocationSummary$Name": "The human-readable name of the benefit allocation.
" } }, "BenefitAllocationStatus": { "base": null, "refs": { "BenefitAllocationSummary$Status": "The current status of the benefit allocation.
", "CreditCode$Status": "The current status of the credit code (e.g., active, redeemed, expired).
", "GetBenefitAllocationOutput$Status": "The current status of the benefit allocation (e.g., active, expired, consumed).
", "ListBenefitAllocationsInputStatusList$member": null } }, "BenefitAllocationSummaries": { "base": null, "refs": { "ListBenefitAllocationsOutput$BenefitAllocationSummaries": "A list of benefit allocation summaries matching the specified criteria.
" } }, "BenefitAllocationSummary": { "base": "A summary view of a benefit allocation containing key information for list operations.
", "refs": { "BenefitAllocationSummaries$member": null } }, "BenefitApplicationDescription": { "base": null, "refs": { "CreateBenefitApplicationInput$Description": "A detailed description of the benefit application and its intended use.
", "GetBenefitApplicationOutput$Description": "A detailed description of the benefit application.
", "UpdateBenefitApplicationInput$Description": "The updated detailed description of the benefit application.
" } }, "BenefitApplicationId": { "base": null, "refs": { "AssociateBenefitApplicationResourceOutput$Id": "The unique identifier of the benefit application after the resource association.
", "BenefitAllocationSummary$BenefitApplicationId": "The identifier of the benefit application that resulted in this allocation.
", "BenefitApplicationSummary$Id": "The unique identifier of the benefit application.
", "CreateBenefitApplicationOutput$Id": "The unique identifier assigned to the newly created benefit application.
", "DisassociateBenefitApplicationResourceOutput$Id": "The unique identifier of the benefit application after the resource disassociation.
", "GetBenefitAllocationOutput$BenefitApplicationId": "The identifier of the benefit application that resulted in this allocation.
", "GetBenefitApplicationOutput$Id": "The unique identifier of the benefit application.
", "UpdateBenefitApplicationOutput$Id": "The unique identifier of the updated benefit application.
" } }, "BenefitApplicationIdentifier": { "base": null, "refs": { "AmendBenefitApplicationInput$Identifier": "The unique identifier of the benefit application to be amended.
", "AssociateBenefitApplicationResourceInput$BenefitApplicationIdentifier": "The unique identifier of the benefit application to associate the resource with.
", "CancelBenefitApplicationInput$Identifier": "The unique identifier of the benefit application to cancel.
", "DisassociateBenefitApplicationResourceInput$BenefitApplicationIdentifier": "The unique identifier of the benefit application to disassociate the resource from.
", "GetBenefitApplicationInput$Identifier": "The unique identifier of the benefit application to retrieve.
", "ListBenefitAllocationsInputBenefitApplicationIdentifiersList$member": null, "RecallBenefitApplicationInput$Identifier": "The unique identifier of the benefit application to recall.
", "SubmitBenefitApplicationInput$Identifier": "The unique identifier of the benefit application to submit.
", "UpdateBenefitApplicationInput$Identifier": "The unique identifier of the benefit application to update.
" } }, "BenefitApplicationName": { "base": null, "refs": { "BenefitApplicationSummary$Name": "The human-readable name of the benefit application.
", "CreateBenefitApplicationInput$Name": "A human-readable name for the benefit application.
", "GetBenefitApplicationOutput$Name": "The human-readable name of the benefit application.
", "UpdateBenefitApplicationInput$Name": "The updated human-readable name for the benefit application.
" } }, "BenefitApplicationStage": { "base": null, "refs": { "BenefitApplicationSummary$Stage": "The current stage in the benefit application processing workflow..
", "GetBenefitApplicationOutput$Stage": "The current stage in the benefit application processing workflow.
", "ListBenefitApplicationsInputStagesList$member": null } }, "BenefitApplicationStatus": { "base": null, "refs": { "BenefitApplicationSummary$Status": "The current processing status of the benefit application.
", "GetBenefitApplicationOutput$Status": "The current processing status of the benefit application.
", "ListBenefitApplicationsInputStatusList$member": null } }, "BenefitApplicationSummaries": { "base": null, "refs": { "ListBenefitApplicationsOutput$BenefitApplicationSummaries": "A list of benefit application summaries matching the specified criteria.
" } }, "BenefitApplicationSummary": { "base": "A summary view of a benefit application containing key information for list operations.
", "refs": { "BenefitApplicationSummaries$member": null } }, "BenefitId": { "base": null, "refs": { "BenefitAllocationSummary$BenefitId": "The identifier of the benefit that this allocation is based on.
", "BenefitApplicationSummary$BenefitId": "The identifier of the benefit being requested in this application.
", "BenefitIdentifiers$member": null, "BenefitIds$member": null, "GetBenefitAllocationOutput$BenefitId": "The identifier of the benefit that this allocation is based on.
", "GetBenefitApplicationOutput$BenefitId": "The identifier of the benefit being requested in this application.
", "ListBenefitAllocationsInputBenefitIdentifiersList$member": null, "ListBenefitApplicationsInputBenefitIdentifiersList$member": null } }, "BenefitIdentifiers": { "base": null, "refs": { "GetBenefitAllocationOutput$ApplicableBenefitIds": "A list of benefit identifiers that this allocation can be applied to.
" } }, "BenefitIds": { "base": null, "refs": { "BenefitAllocationSummary$ApplicableBenefitIds": "The identifiers of the benefits applicable for this allocation.
" } }, "BenefitStatus": { "base": null, "refs": { "BenefitSummary$Status": "The current status of the benefit.
", "GetBenefitOutput$Status": "The current status of the benefit (e.g., active, inactive, deprecated).
", "ListBenefitsInputStatusList$member": null } }, "BenefitSummaries": { "base": null, "refs": { "ListBenefitsOutput$BenefitSummaries": "A list of benefit summaries matching the specified criteria.
" } }, "BenefitSummary": { "base": "A summary view of a benefit containing key information for list operations.
", "refs": { "BenefitSummaries$member": null } }, "BenefitSummaryDescriptionString": { "base": null, "refs": { "BenefitSummary$Description": "A brief description of the benefit and its purpose.
" } }, "BenefitSummaryIdString": { "base": null, "refs": { "BenefitSummary$Id": "The unique identifier of the benefit.
" } }, "BenefitSummaryNameString": { "base": null, "refs": { "BenefitSummary$Name": "The human-readable name of the benefit.
" } }, "CancelBenefitApplicationInput": { "base": null, "refs": {} }, "CancelBenefitApplicationInputClientTokenString": { "base": null, "refs": { "CancelBenefitApplicationInput$ClientToken": "A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.
" } }, "CancelBenefitApplicationInputReasonString": { "base": null, "refs": { "CancelBenefitApplicationInput$Reason": "A descriptive reason explaining why the benefit application is being cancelled.
" } }, "CancelBenefitApplicationOutput": { "base": null, "refs": {} }, "CatalogName": { "base": null, "refs": { "AmendBenefitApplicationInput$Catalog": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "AssociateBenefitApplicationResourceInput$Catalog": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "BenefitAllocationSummary$Catalog": "The catalog identifier that the benefit allocation belongs to.
", "BenefitApplicationSummary$Catalog": "The catalog identifier that the benefit application belongs to.
", "BenefitSummary$Catalog": "The catalog identifier that the benefit belongs to.
", "CancelBenefitApplicationInput$Catalog": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "CreateBenefitApplicationInput$Catalog": "The catalog identifier that specifies which benefit catalog to create the application in.
", "DisassociateBenefitApplicationResourceInput$Catalog": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "GetBenefitAllocationInput$Catalog": "The catalog identifier that specifies which benefit catalog to query.
", "GetBenefitAllocationOutput$Catalog": "The catalog identifier that the benefit allocation belongs to.
", "GetBenefitApplicationInput$Catalog": "The catalog identifier that specifies which benefit catalog to query.
", "GetBenefitApplicationOutput$Catalog": "The catalog identifier that the benefit application belongs to.
", "GetBenefitInput$Catalog": "The catalog identifier that specifies which benefit catalog to query.
", "GetBenefitOutput$Catalog": "The catalog identifier that the benefit belongs to.
", "ListBenefitAllocationsInput$Catalog": "The catalog identifier to filter benefit allocations by catalog.
", "ListBenefitApplicationsInput$Catalog": "The catalog identifier to filter benefit applications by catalog.
", "ListBenefitsInput$Catalog": "The catalog identifier to filter benefits by catalog.
", "RecallBenefitApplicationInput$Catalog": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "SubmitBenefitApplicationInput$Catalog": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "UpdateBenefitApplicationInput$Catalog": "The catalog identifier that specifies which benefit catalog the application belongs to.
" } }, "ConflictException": { "base": "Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
", "refs": {} }, "ConsumableDetails": { "base": "Contains information about consumable benefit fulfillment, such as usage quotas or service limits.
", "refs": { "FulfillmentDetails$ConsumableDetails": "Details about consumable-based fulfillment, if applicable to this benefit allocation.
" } }, "Contact": { "base": "Represents contact information for a partner representative.
", "refs": { "Contacts$member": null, "CreateBenefitApplicationInputPartnerContactsList$member": null, "UpdateBenefitApplicationInputPartnerContactsList$member": null } }, "ContactBusinessTitleString": { "base": null, "refs": { "Contact$BusinessTitle": "The business title or role of the contact person within the organization.
" } }, "ContactEmail": { "base": null, "refs": { "Contact$Email": "The email address of the contact person.
" } }, "ContactFirstName": { "base": null, "refs": { "Contact$FirstName": "The first name of the contact person.
" } }, "ContactLastName": { "base": null, "refs": { "Contact$LastName": "The last name of the contact person.
" } }, "ContactPhone": { "base": null, "refs": { "Contact$Phone": "The phone number of the contact person.
" } }, "Contacts": { "base": null, "refs": { "GetBenefitApplicationOutput$PartnerContacts": "Contact information for partner representatives responsible for this benefit application.
" } }, "CreateBenefitApplicationInput": { "base": null, "refs": {} }, "CreateBenefitApplicationInputAssociatedResourcesList": { "base": null, "refs": { "CreateBenefitApplicationInput$AssociatedResources": "AWS resources that are associated with this benefit application.
" } }, "CreateBenefitApplicationInputBenefitIdentifierString": { "base": null, "refs": { "CreateBenefitApplicationInput$BenefitIdentifier": "The unique identifier of the benefit being requested in this application.
" } }, "CreateBenefitApplicationInputClientTokenString": { "base": null, "refs": { "CreateBenefitApplicationInput$ClientToken": "A unique, case-sensitive identifier to ensure idempotent processing of the creation request.
" } }, "CreateBenefitApplicationInputFileDetailsList": { "base": null, "refs": { "CreateBenefitApplicationInput$FileDetails": "Supporting documents and files attached to the benefit application.
" } }, "CreateBenefitApplicationInputPartnerContactsList": { "base": null, "refs": { "CreateBenefitApplicationInput$PartnerContacts": "Contact information for partner representatives responsible for this benefit application.
" } }, "CreateBenefitApplicationInputTagsList": { "base": null, "refs": { "CreateBenefitApplicationInput$Tags": "Key-value pairs to categorize and organize the benefit application.
" } }, "CreateBenefitApplicationOutput": { "base": null, "refs": {} }, "CreditCode": { "base": "Represents an AWS credit code that can be applied to an AWS account for billing purposes.
", "refs": { "CreditCodes$member": null } }, "CreditCodes": { "base": null, "refs": { "CreditDetails$Codes": "A list of credit codes that have been generated for this benefit allocation.
" } }, "CreditDetails": { "base": "Contains information about credit-based benefit fulfillment, including AWS promotional credits.
", "refs": { "FulfillmentDetails$CreditDetails": "Details about credit-based fulfillment, if applicable to this benefit allocation.
" } }, "CurrencyCode": { "base": null, "refs": { "MonetaryValue$CurrencyCode": "The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
" } }, "DisassociateBenefitApplicationResourceInput": { "base": null, "refs": {} }, "DisassociateBenefitApplicationResourceInputResourceArnString": { "base": null, "refs": { "DisassociateBenefitApplicationResourceInput$ResourceArn": "The Amazon Resource Name (ARN) of the AWS resource to disassociate from the benefit application.
" } }, "DisassociateBenefitApplicationResourceOutput": { "base": null, "refs": {} }, "DisbursementDetails": { "base": "Contains information about disbursement-based benefit fulfillment, such as direct payments or reimbursements.
", "refs": { "FulfillmentDetails$DisbursementDetails": "Details about disbursement-based fulfillment, if applicable to this benefit allocation.
" } }, "Document": { "base": null, "refs": { "CreateBenefitApplicationInput$BenefitApplicationDetails": "Detailed information and requirements specific to the benefit being requested.
", "GetBenefitApplicationOutput$BenefitApplicationDetails": "Detailed information and requirements specific to the benefit being requested.
", "GetBenefitOutput$BenefitRequestSchema": "The schema definition that describes the required fields for requesting this benefit.
", "UpdateBenefitApplicationInput$BenefitApplicationDetails": "Updated detailed information and requirements specific to the benefit being requested.
" } }, "FileDetail": { "base": "Represents detailed information about a file attached to a benefit application.
", "refs": { "GetBenefitApplicationOutputFileDetailsList$member": null } }, "FileDetailCreatedByString": { "base": null, "refs": { "FileDetail$CreatedBy": "The identifier of the user who uploaded the file.
" } }, "FileDetailFileNameString": { "base": null, "refs": { "FileDetail$FileName": "The original name of the uploaded file.
" } }, "FileDetailFileStatusString": { "base": null, "refs": { "FileDetail$FileStatus": "The current processing status of the file (e.g., uploaded, processing, approved, rejected).
" } }, "FileInput": { "base": "Represents input information for uploading a file to a benefit application.
", "refs": { "CreateBenefitApplicationInputFileDetailsList$member": null, "UpdateBenefitApplicationInputFileDetailsList$member": null } }, "FileType": { "base": null, "refs": { "FileDetail$FileType": "The type or category of the file (e.g., document, image, spreadsheet).
" } }, "FileURI": { "base": null, "refs": { "FileDetail$FileURI": "The URI or location where the file is stored.
", "FileInput$FileURI": "The URI or location where the file should be stored or has been uploaded.
" } }, "FulfillmentDetails": { "base": "Contains comprehensive information about how a benefit allocation is fulfilled across different fulfillment types.
", "refs": { "GetBenefitAllocationOutput$FulfillmentDetail": "Detailed information about how the benefit allocation is fulfilled.
" } }, "FulfillmentType": { "base": null, "refs": { "FulfillmentTypes$member": null, "GetBenefitAllocationOutput$FulfillmentType": "The fulfillment type used for this benefit allocation.
", "ListBenefitAllocationsInputFulfillmentTypesList$member": null, "ListBenefitApplicationsInputFulfillmentTypesList$member": null, "ListBenefitsInputFulfillmentTypesList$member": null } }, "FulfillmentTypes": { "base": null, "refs": { "BenefitAllocationSummary$FulfillmentTypes": "The fulfillment types used for this benefit allocation.
", "BenefitApplicationSummary$FulfillmentTypes": "The fulfillment types requested for this benefit application.
", "BenefitSummary$FulfillmentTypes": "The available fulfillment types for this benefit.
", "CreateBenefitApplicationInput$FulfillmentTypes": "The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
", "GetBenefitApplicationOutput$FulfillmentTypes": "The fulfillment types requested for this benefit application.
", "GetBenefitOutput$FulfillmentTypes": "The available fulfillment types for this benefit (e.g., credits, access, disbursement).
" } }, "GetBenefitAllocationInput": { "base": null, "refs": {} }, "GetBenefitAllocationOutput": { "base": null, "refs": {} }, "GetBenefitApplicationInput": { "base": null, "refs": {} }, "GetBenefitApplicationOutput": { "base": null, "refs": {} }, "GetBenefitApplicationOutputAssociatedResourcesList": { "base": null, "refs": { "GetBenefitApplicationOutput$AssociatedResources": "AWS resources that are associated with this benefit application.
" } }, "GetBenefitApplicationOutputFileDetailsList": { "base": null, "refs": { "GetBenefitApplicationOutput$FileDetails": "Supporting documents and files attached to the benefit application.
" } }, "GetBenefitApplicationOutputStatusReasonString": { "base": null, "refs": { "GetBenefitApplicationOutput$StatusReason": "Additional information explaining the current status of the benefit application.
" } }, "GetBenefitInput": { "base": null, "refs": {} }, "GetBenefitInputIdentifierString": { "base": null, "refs": { "GetBenefitInput$Identifier": "The unique identifier of the benefit to retrieve.
" } }, "GetBenefitOutput": { "base": null, "refs": {} }, "GetBenefitOutputDescriptionString": { "base": null, "refs": { "GetBenefitOutput$Description": "A detailed description of the benefit and its purpose.
" } }, "GetBenefitOutputIdString": { "base": null, "refs": { "GetBenefitOutput$Id": "The unique identifier of the benefit.
" } }, "GetBenefitOutputNameString": { "base": null, "refs": { "GetBenefitOutput$Name": "The human-readable name of the benefit.
" } }, "InternalServerException": { "base": "Thrown when an unexpected error occurs on the server side during request processing.
", "refs": {} }, "IssuanceDetail": { "base": "Represents detailed information about a specific issuance of benefit value.
", "refs": { "ConsumableDetails$IssuanceDetails": "Detailed information about how the consumable benefit was issued and distributed.
", "DisbursementDetails$IssuanceDetails": "Detailed information about how the disbursement was issued and processed.
" } }, "ListBenefitAllocationsInput": { "base": null, "refs": {} }, "ListBenefitAllocationsInputBenefitApplicationIdentifiersList": { "base": null, "refs": { "ListBenefitAllocationsInput$BenefitApplicationIdentifiers": "Filter benefit allocations by specific benefit application identifiers.
" } }, "ListBenefitAllocationsInputBenefitIdentifiersList": { "base": null, "refs": { "ListBenefitAllocationsInput$BenefitIdentifiers": "Filter benefit allocations by specific benefit identifiers.
" } }, "ListBenefitAllocationsInputFulfillmentTypesList": { "base": null, "refs": { "ListBenefitAllocationsInput$FulfillmentTypes": "Filter benefit allocations by specific fulfillment types.
" } }, "ListBenefitAllocationsInputMaxResultsInteger": { "base": null, "refs": { "ListBenefitAllocationsInput$MaxResults": "The maximum number of benefit allocations to return in a single response.
" } }, "ListBenefitAllocationsInputNextTokenString": { "base": null, "refs": { "ListBenefitAllocationsInput$NextToken": "A pagination token to retrieve the next set of results from a previous request.
" } }, "ListBenefitAllocationsInputStatusList": { "base": null, "refs": { "ListBenefitAllocationsInput$Status": "Filter benefit allocations by their current status.
" } }, "ListBenefitAllocationsOutput": { "base": null, "refs": {} }, "ListBenefitAllocationsOutputNextTokenString": { "base": null, "refs": { "ListBenefitAllocationsOutput$NextToken": "A pagination token to retrieve the next set of results, if more results are available.
" } }, "ListBenefitApplicationsInput": { "base": null, "refs": {} }, "ListBenefitApplicationsInputBenefitIdentifiersList": { "base": null, "refs": { "ListBenefitApplicationsInput$BenefitIdentifiers": "Filter benefit applications by specific benefit identifiers.
" } }, "ListBenefitApplicationsInputFulfillmentTypesList": { "base": null, "refs": { "ListBenefitApplicationsInput$FulfillmentTypes": "Filter benefit applications by specific fulfillment types.
" } }, "ListBenefitApplicationsInputMaxResultsInteger": { "base": null, "refs": { "ListBenefitApplicationsInput$MaxResults": "The maximum number of benefit applications to return in a single response.
" } }, "ListBenefitApplicationsInputNextTokenString": { "base": null, "refs": { "ListBenefitApplicationsInput$NextToken": "A pagination token to retrieve the next set of results from a previous request.
" } }, "ListBenefitApplicationsInputProgramsList": { "base": null, "refs": { "ListBenefitApplicationsInput$Programs": "Filter benefit applications by specific AWS partner programs.
" } }, "ListBenefitApplicationsInputStagesList": { "base": null, "refs": { "ListBenefitApplicationsInput$Stages": "Filter benefit applications by their current processing stage.
" } }, "ListBenefitApplicationsInputStatusList": { "base": null, "refs": { "ListBenefitApplicationsInput$Status": "Filter benefit applications by their current processing status.
" } }, "ListBenefitApplicationsOutput": { "base": null, "refs": {} }, "ListBenefitApplicationsOutputNextTokenString": { "base": null, "refs": { "ListBenefitApplicationsOutput$NextToken": "A pagination token to retrieve the next set of results, if more results are available.
" } }, "ListBenefitsInput": { "base": null, "refs": {} }, "ListBenefitsInputFulfillmentTypesList": { "base": null, "refs": { "ListBenefitsInput$FulfillmentTypes": "Filter benefits by specific fulfillment types.
" } }, "ListBenefitsInputMaxResultsInteger": { "base": null, "refs": { "ListBenefitsInput$MaxResults": "The maximum number of benefits to return in a single response.
" } }, "ListBenefitsInputNextTokenString": { "base": null, "refs": { "ListBenefitsInput$NextToken": "A pagination token to retrieve the next set of results from a previous request.
" } }, "ListBenefitsInputProgramsList": { "base": null, "refs": { "ListBenefitsInput$Programs": "Filter benefits by specific AWS partner programs.
" } }, "ListBenefitsInputStatusList": { "base": null, "refs": { "ListBenefitsInput$Status": "Filter benefits by their current status.
" } }, "ListBenefitsOutput": { "base": null, "refs": {} }, "ListBenefitsOutputNextTokenString": { "base": null, "refs": { "ListBenefitsOutput$NextToken": "A pagination token to retrieve the next set of results, if more results are available.
" } }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "MonetaryValue": { "base": "Represents a monetary amount with its associated currency.
", "refs": { "ConsumableDetails$AllocatedAmount": "The total amount of the consumable benefit that has been allocated.
", "ConsumableDetails$RemainingAmount": "The remaining amount of the consumable benefit that is still available for use.
", "ConsumableDetails$UtilizedAmount": "The amount of the consumable benefit that has already been used.
", "CreditCode$Value": "The monetary value of the credit code.
", "CreditDetails$AllocatedAmount": "The total amount of credits that have been allocated for this benefit.
", "CreditDetails$IssuedAmount": "The amount of credits that have actually been issued and are available for use.
", "DisbursementDetails$DisbursedAmount": "The total amount that has been disbursed for this benefit allocation.
", "IssuanceDetail$IssuanceAmount": "The monetary amount or value that was issued in this specific issuance.
" } }, "Program": { "base": null, "refs": { "ListBenefitApplicationsInputProgramsList$member": null, "ListBenefitsInputProgramsList$member": null, "Programs$member": null } }, "Programs": { "base": null, "refs": { "BenefitApplicationSummary$Programs": "The AWS partner programs associated with this benefit application.
", "BenefitSummary$Programs": "The AWS partner programs that this benefit is associated with.
", "GetBenefitApplicationOutput$Programs": "The AWS partner programs associated with this benefit application.
", "GetBenefitOutput$Programs": "The AWS partner programs that this benefit is associated with.
" } }, "RecallBenefitApplicationInput": { "base": null, "refs": {} }, "RecallBenefitApplicationOutput": { "base": null, "refs": {} }, "ResourceNotFoundException": { "base": "Thrown when the requested resource cannot be found or does not exist.
", "refs": {} }, "ResourceType": { "base": null, "refs": { "AssociatedResource$ResourceType": "The type of AWS resource (e.g., EC2 instance, S3 bucket, Lambda function).
" } }, "ServiceQuotaExceededException": { "base": "Thrown when the request would exceed the service quotas or limits for the account.
", "refs": {} }, "StatusReasonCode": { "base": null, "refs": { "GetBenefitApplicationOutput$StatusReasonCode": "A standardized code representing the reason for the current status.
", "StatusReasonCodes$member": null } }, "StatusReasonCodes": { "base": "List of StatusReasonCodes
", "refs": { "GetBenefitApplicationOutput$StatusReasonCodes": "The list of standardized codes representing the reason for the current status.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$Message": "A message describing the access denial.
", "AccessDetails$Description": "A description of the access privileges or permissions granted by this benefit.
", "AmendBenefitApplicationInput$Revision": "The current revision number of the benefit application to ensure optimistic concurrency control.
", "Amendment$FieldPath": "The JSON path or field identifier specifying which field in the benefit application to modify.
", "Amendment$NewValue": "The new value to set for the specified field in the benefit application.
", "AssociateBenefitApplicationResourceOutput$Arn": "The Amazon Resource Name (ARN) of the benefit application after the resource association.
", "AssociateBenefitApplicationResourceOutput$Revision": "The updated revision number of the benefit application after the resource association.
", "AssociatedResource$ResourceIdentifier": "The unique identifier of the AWS resource within its service.
", "Attributes$key": null, "Attributes$value": null, "BenefitAllocationSummary$Arn": "The Amazon Resource Name (ARN) of the benefit allocation.
", "BenefitAllocationSummary$StatusReason": "Additional information explaining the current status of the benefit allocation.
", "BenefitApplicationSummary$Arn": "The Amazon Resource Name (ARN) of the benefit application.
", "BenefitSummary$Arn": "The Amazon Resource Name (ARN) of the benefit.
", "ConflictException$Message": "A message describing the conflict.
", "CreateBenefitApplicationOutput$Arn": "The Amazon Resource Name (ARN) of the newly created benefit application.
", "CreateBenefitApplicationOutput$Revision": "The initial revision number of the newly created benefit application.
", "CreditCode$AwsAccountId": "The AWS account ID that the credit code is associated with or can be applied to.
", "CreditCode$AwsCreditCode": "The actual credit code string that can be redeemed in the AWS billing console.
", "DisassociateBenefitApplicationResourceOutput$Arn": "The Amazon Resource Name (ARN) of the benefit application after the resource disassociation.
", "DisassociateBenefitApplicationResourceOutput$Revision": "The updated revision number of the benefit application after the resource disassociation.
", "FileDetail$BusinessUseCase": "The business purpose or use case that this file supports in the benefit application.
", "FileDetail$FileStatusReason": "The reason for that particulat file status.
", "FileInput$BusinessUseCase": "The business purpose or use case that this file supports in the benefit application.
", "GetBenefitAllocationOutput$Name": "The human-readable name of the benefit allocation.
", "GetBenefitAllocationOutput$Description": "A detailed description of the benefit allocation.
", "GetBenefitAllocationOutput$StatusReason": "Additional information explaining the current status of the benefit allocation.
", "GetBenefitApplicationOutput$Revision": "The current revision number of the benefit application.
", "GetBenefitOutput$Arn": "The Amazon Resource Name (ARN) of the benefit.
", "InternalServerException$Message": "A message describing the internal server error.
", "IssuanceDetail$IssuanceId": "The unique identifier for this specific issuance.
", "MonetaryValue$Amount": "The numeric amount of the monetary value.
", "RecallBenefitApplicationInput$ClientToken": "A unique, case-sensitive identifier to ensure idempotent processing of the recall request.
", "RecallBenefitApplicationInput$Reason": "A descriptive reason explaining why the benefit application is being recalled.
", "ResourceNotFoundException$Message": "A message describing the resource not found error.
", "ServiceQuotaExceededException$Message": "A message describing the service quota exceeded error.
", "ServiceQuotaExceededException$ResourceId": "The identifier of the resource that would exceed the quota.
", "ServiceQuotaExceededException$ResourceType": "The type of the resource that would exceed the quota.
", "ServiceQuotaExceededException$QuotaCode": "The code identifying the specific quota that would be exceeded.
", "ThrottlingException$Message": "A message describing the throttling error.
", "UpdateBenefitApplicationInput$Revision": "The current revision number of the benefit application to ensure optimistic concurrency control.
", "UpdateBenefitApplicationOutput$Arn": "The Amazon Resource Name (ARN) of the updated benefit application.
", "UpdateBenefitApplicationOutput$Revision": "The new revision number of the benefit application after the update.
", "ValidationException$Message": "A message describing the validation error.
", "ValidationExceptionField$Name": "The name of the field that failed validation.
", "ValidationExceptionField$Message": "A detailed message explaining why the field validation failed.
" } }, "SubmitBenefitApplicationInput": { "base": null, "refs": {} }, "SubmitBenefitApplicationOutput": { "base": null, "refs": {} }, "Tag": { "base": "Represents a key-value pair used for categorizing and organizing AWS resources.
", "refs": { "CreateBenefitApplicationInputTagsList$member": null, "Tags$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The tag key, which acts as a category or label for the tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "A list of tag keys to remove from the resource.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tag$Value": "The tag value, which provides additional information or context for the tag key.
" } }, "TaggableResourceArn": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to list tags for.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to add tags to.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to remove tags from.
" } }, "Tags": { "base": null, "refs": { "ListTagsForResourceResponse$tags": "A list of key-value pairs representing the tags associated with the resource.
", "TagResourceRequest$tags": "A list of key-value pairs to add as tags to the resource.
" } }, "ThrottlingException": { "base": "Thrown when the request rate exceeds the allowed limits and the request is being throttled.
", "refs": {} }, "Timestamp": { "base": null, "refs": { "BenefitAllocationSummary$CreatedAt": "The timestamp when the benefit allocation was created.
", "BenefitAllocationSummary$ExpiresAt": "The timestamp when the benefit allocation expires.
", "BenefitApplicationSummary$CreatedAt": "The timestamp when the benefit application was created.
", "BenefitApplicationSummary$UpdatedAt": "The timestamp when the benefit application was last updated.
", "CreditCode$IssuedAt": "The timestamp when the credit code was issued.
", "CreditCode$ExpiresAt": "The timestamp when the credit code expires and can no longer be redeemed.
", "FileDetail$CreatedAt": "The timestamp when the file was uploaded.
", "GetBenefitAllocationOutput$CreatedAt": "The timestamp when the benefit allocation was created.
", "GetBenefitAllocationOutput$UpdatedAt": "The timestamp when the benefit allocation was last updated.
", "GetBenefitAllocationOutput$StartsAt": "The timestamp when the benefit allocation becomes active and usable.
", "GetBenefitAllocationOutput$ExpiresAt": "The timestamp when the benefit allocation expires and is no longer usable.
", "GetBenefitApplicationOutput$CreatedAt": "The timestamp when the benefit application was created.
", "GetBenefitApplicationOutput$UpdatedAt": "The timestamp when the benefit application was last updated.
", "IssuanceDetail$IssuedAt": "The timestamp when this specific issuance was processed.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateBenefitApplicationInput": { "base": null, "refs": {} }, "UpdateBenefitApplicationInputClientTokenString": { "base": null, "refs": { "UpdateBenefitApplicationInput$ClientToken": "A unique, case-sensitive identifier to ensure idempotent processing of the update request.
" } }, "UpdateBenefitApplicationInputFileDetailsList": { "base": null, "refs": { "UpdateBenefitApplicationInput$FileDetails": "Updated supporting documents and files attached to the benefit application.
" } }, "UpdateBenefitApplicationInputPartnerContactsList": { "base": null, "refs": { "UpdateBenefitApplicationInput$PartnerContacts": "Updated contact information for partner representatives responsible for this benefit application.
" } }, "UpdateBenefitApplicationOutput": { "base": null, "refs": {} }, "ValidationException": { "base": "Thrown when the request contains invalid parameters or fails input validation requirements.
", "refs": {} }, "ValidationExceptionErrorCode": { "base": null, "refs": { "ValidationExceptionField$Code": "An error code explaining why the field validation failed.
" } }, "ValidationExceptionField": { "base": "Represents a field-specific validation error with detailed information.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$FieldList": "A list of fields that failed validation.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$Reason": "The reason for the validation failure.
" } } } }