{ "smithy": "2.0", "shapes": { "com.amazonaws.partnercentralbenefits#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "
A message describing the access denial.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Thrown when the caller does not have sufficient permissions to perform the requested operation.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.partnercentralbenefits#AccessDetails": { "type": "structure", "members": { "Description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the access privileges or permissions granted by this benefit.
" } } }, "traits": { "smithy.api#documentation": "Contains information about access-based benefit fulfillment, such as service permissions or feature access.
" } }, "com.amazonaws.partnercentralbenefits#AmendBenefitApplication": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#AmendBenefitApplicationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#AmendBenefitApplicationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Modifies an existing benefit application by applying amendments to specific fields while maintaining revision control.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/AmendBenefitApplication" } } }, "com.amazonaws.partnercentralbenefits#AmendBenefitApplicationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "smithy.api#required": {} } }, "ClientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-]{1,64}$", "smithy.api#required": {} } }, "Revision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The current revision number of the benefit application to ensure optimistic concurrency control.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to be amended.
", "smithy.api#required": {} } }, "AmendmentReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A descriptive reason explaining why the benefit application is being amended.
", "smithy.api#length": { "max": 1000 }, "smithy.api#required": {} } }, "Amendments": { "target": "com.amazonaws.partnercentralbenefits#AmendmentList", "traits": { "smithy.api#documentation": "A list of specific field amendments to apply to the benefit application.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#AmendBenefitApplicationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#Amendment": { "type": "structure", "members": { "FieldPath": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The JSON path or field identifier specifying which field in the benefit application to modify.
", "smithy.api#required": {} } }, "NewValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The new value to set for the specified field in the benefit application.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a specific change to be made to a benefit application field.
" } }, "com.amazonaws.partnercentralbenefits#AmendmentList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#Amendment" } }, "com.amazonaws.partnercentralbenefits#Arn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$" } }, "com.amazonaws.partnercentralbenefits#Arns": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#Arn" } }, "com.amazonaws.partnercentralbenefits#AssociateBenefitApplicationResource": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#AssociateBenefitApplicationResourceInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#AssociateBenefitApplicationResourceOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Links an AWS resource to an existing benefit application for tracking and management purposes.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/AssociateBenefitApplicationResource" } } }, "com.amazonaws.partnercentralbenefits#AssociateBenefitApplicationResourceInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "smithy.api#required": {} } }, "BenefitApplicationIdentifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to associate the resource with.
", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.partnercentralbenefits#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS resource to associate with the benefit application.
", "smithy.api#length": { "min": 0, "max": 1600 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#AssociateBenefitApplicationResourceOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application after the resource association.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit application after the resource association.
" } }, "Revision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The updated revision number of the benefit application after the resource association.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#AssociatedResource": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.partnercentralbenefits#ResourceType", "traits": { "smithy.api#documentation": "The type of AWS resource (e.g., EC2 instance, S3 bucket, Lambda function).
" } }, "ResourceIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#deprecated": { "message": "This field is no longer used", "since": "Oct 08 2025" }, "smithy.api#documentation": "The unique identifier of the AWS resource within its service.
" } }, "ResourceArn": { "target": "com.amazonaws.partnercentralbenefits#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the AWS resource.
" } } }, "traits": { "smithy.api#documentation": "Represents an AWS resource that is associated with a benefit application for tracking and management.
" } }, "com.amazonaws.partnercentralbenefits#AssociatedResources": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#AssociatedResource" } }, "com.amazonaws.partnercentralbenefits#Attributes": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.partnercentralbenefits#Benefit": { "type": "resource", "identifiers": { "BenefitId": { "target": "com.amazonaws.partnercentralbenefits#BenefitId" }, "CatalogName": { "target": "smithy.api#String" } }, "traits": { "aws.api#arn": { "template": "catalog/{CatalogName}/benefit/ben-{BenefitId}", "noAccount": true }, "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:Programs", "partnercentral:FulfillmentTypes" ], "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.partnercentralbenefits#BenefitAllocation": { "type": "resource", "identifiers": { "BenefitAllocationId": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationId" }, "CatalogName": { "target": "smithy.api#String" } }, "traits": { "aws.api#arn": { "template": "catalog/{CatalogName}/benefit-allocation/benalloc-{BenefitAllocationId}" }, "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes" ], "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationArn": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:.+benalloc-[0-9a-z]{14})$" } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationId": { "type": "string", "traits": { "smithy.api#pattern": "^benalloc-[0-9a-z]{14}$" } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:.+|benalloc-[0-9a-z]{14})$" } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "FULFILLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULFILLED" } } } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationStatusList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationStatus" } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationSummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationSummary" } }, "com.amazonaws.partnercentralbenefits#BenefitAllocationSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationId", "traits": { "smithy.api#documentation": "The unique identifier of the benefit allocation.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that the benefit allocation belongs to.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit allocation.
" } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationStatus", "traits": { "smithy.api#documentation": "The current status of the benefit allocation.
" } }, "StatusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Additional information explaining the current status of the benefit allocation.
" } }, "Name": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationName", "traits": { "smithy.api#documentation": "The human-readable name of the benefit allocation.
" } }, "BenefitId": { "target": "com.amazonaws.partnercentralbenefits#BenefitId", "traits": { "smithy.api#documentation": "The identifier of the benefit that this allocation is based on.
" } }, "BenefitApplicationId": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The identifier of the benefit application that resulted in this allocation.
" } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "The fulfillment types used for this benefit allocation.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit allocation was created.
" } }, "ExpiresAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit allocation expires.
" } }, "ApplicableBenefitIds": { "target": "com.amazonaws.partnercentralbenefits#BenefitIds", "traits": { "smithy.api#documentation": "The identifiers of the benefits applicable for this allocation.
" } } }, "traits": { "smithy.api#documentation": "A summary view of a benefit allocation containing key information for list operations.
" } }, "com.amazonaws.partnercentralbenefits#BenefitApplication": { "type": "resource", "identifiers": { "BenefitApplicationId": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId" }, "CatalogName": { "target": "smithy.api#String" } }, "traits": { "aws.api#arn": { "template": "catalog/{CatalogName}/benefit-application/benappl-{BenefitApplicationId}" }, "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationId": { "type": "string", "traits": { "smithy.api#pattern": "^benappl-[0-9a-z]{14}$" } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:.+|benappl-[0-9a-z]{14})$" } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier" } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationStage": { "type": "string" }, "com.amazonaws.partnercentralbenefits#BenefitApplicationStatus": { "type": "enum", "members": { "PENDING_SUBMISSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_SUBMISSION" } }, "IN_REVIEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_REVIEW" } }, "ACTION_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_REQUIRED" } }, "APPROVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } } } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationSummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationSummary" } }, "com.amazonaws.partnercentralbenefits#BenefitApplicationSummary": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that the benefit application belongs to.
" } }, "Name": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationName", "traits": { "smithy.api#documentation": "The human-readable name of the benefit application.
" } }, "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit application.
" } }, "BenefitId": { "target": "com.amazonaws.partnercentralbenefits#BenefitId", "traits": { "smithy.api#documentation": "The identifier of the benefit being requested in this application.
" } }, "Programs": { "target": "com.amazonaws.partnercentralbenefits#Programs", "traits": { "smithy.api#documentation": "The AWS partner programs associated with this benefit application.
" } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "The fulfillment types requested for this benefit application.
" } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationStatus", "traits": { "smithy.api#documentation": "The current processing status of the benefit application.
" } }, "Stage": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationStage", "traits": { "smithy.api#documentation": "The current stage in the benefit application processing workflow..
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit application was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit application was last updated.
" } }, "BenefitApplicationDetails": { "target": "com.amazonaws.partnercentralbenefits#Attributes", "traits": { "smithy.api#documentation": "Additional attributes and metadata associated with the benefit application.
" } }, "AssociatedResources": { "target": "com.amazonaws.partnercentralbenefits#Arns", "traits": { "smithy.api#documentation": "AWS resources that are associated with this benefit application.
" } } }, "traits": { "smithy.api#documentation": "A summary view of a benefit application containing key information for list operations.
" } }, "com.amazonaws.partnercentralbenefits#BenefitId": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:.+|ben-[0-9a-z]{14})$" } }, "com.amazonaws.partnercentralbenefits#BenefitIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitId" } }, "com.amazonaws.partnercentralbenefits#BenefitIds": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitId" } }, "com.amazonaws.partnercentralbenefits#BenefitStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } } } }, "com.amazonaws.partnercentralbenefits#BenefitStatuses": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitStatus" } }, "com.amazonaws.partnercentralbenefits#BenefitSummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitSummary" } }, "com.amazonaws.partnercentralbenefits#BenefitSummary": { "type": "structure", "members": { "Id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the benefit.
", "smithy.api#pattern": "^ben-[0-9a-z]{14}$" } }, "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that the benefit belongs to.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit.
" } }, "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The human-readable name of the benefit.
", "smithy.api#length": { "min": 1, "max": 100 } } }, "Description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A brief description of the benefit and its purpose.
", "smithy.api#length": { "max": 1000 } } }, "Programs": { "target": "com.amazonaws.partnercentralbenefits#Programs", "traits": { "smithy.api#documentation": "The AWS partner programs that this benefit is associated with.
" } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "The available fulfillment types for this benefit.
" } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitStatus", "traits": { "smithy.api#documentation": "The current status of the benefit.
" } } }, "traits": { "smithy.api#documentation": "A summary view of a benefit containing key information for list operations.
" } }, "com.amazonaws.partnercentralbenefits#CancelBenefitApplication": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#CancelBenefitApplicationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#CancelBenefitApplicationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Cancels a benefit application that is currently in progress, preventing further processing.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/CancelBenefitApplication" } } }, "com.amazonaws.partnercentralbenefits#CancelBenefitApplicationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "smithy.api#required": {} } }, "ClientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-]{1,64}$", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to cancel.
", "smithy.api#required": {} } }, "Reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A descriptive reason explaining why the benefit application is being cancelled.
", "smithy.api#length": { "max": 1000 }, "smithy.api#pattern": "^[\\s\\S]{1,1000}$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#CancelBenefitApplicationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#CatalogName": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.partnercentralbenefits#ConflictException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the conflict.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.partnercentralbenefits#ConsumableDetails": { "type": "structure", "members": { "AllocatedAmount": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The total amount of the consumable benefit that has been allocated.
" } }, "RemainingAmount": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The remaining amount of the consumable benefit that is still available for use.
" } }, "UtilizedAmount": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The amount of the consumable benefit that has already been used.
" } }, "IssuanceDetails": { "target": "com.amazonaws.partnercentralbenefits#IssuanceDetail", "traits": { "smithy.api#documentation": "Detailed information about how the consumable benefit was issued and distributed.
" } } }, "traits": { "smithy.api#documentation": "Contains information about consumable benefit fulfillment, such as usage quotas or service limits.
" } }, "com.amazonaws.partnercentralbenefits#Contact": { "type": "structure", "members": { "Email": { "target": "com.amazonaws.partnercentralbenefits#ContactEmail", "traits": { "smithy.api#documentation": "The email address of the contact person.
" } }, "FirstName": { "target": "com.amazonaws.partnercentralbenefits#ContactFirstName", "traits": { "smithy.api#documentation": "The first name of the contact person.
" } }, "LastName": { "target": "com.amazonaws.partnercentralbenefits#ContactLastName", "traits": { "smithy.api#documentation": "The last name of the contact person.
" } }, "BusinessTitle": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The business title or role of the contact person within the organization.
", "smithy.api#length": { "min": 0, "max": 80 } } }, "Phone": { "target": "com.amazonaws.partnercentralbenefits#ContactPhone", "traits": { "smithy.api#documentation": "The phone number of the contact person.
" } } }, "traits": { "smithy.api#documentation": "Represents contact information for a partner representative.
" } }, "com.amazonaws.partnercentralbenefits#ContactEmail": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 80 }, "smithy.api#pattern": "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralbenefits#ContactFirstName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 80 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralbenefits#ContactLastName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 80 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralbenefits#ContactPhone": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralbenefits#Contacts": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#Contact" } }, "com.amazonaws.partnercentralbenefits#CreateBenefitApplication": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#CreateBenefitApplicationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#CreateBenefitApplicationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "Creates a new benefit application for a partner to request access to AWS benefits and programs.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/CreateBenefitApplication" }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralbenefits#CreateBenefitApplicationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog to create the application in.
", "smithy.api#required": {} } }, "ClientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotent processing of the creation request.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[!-~]{1,64}$", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationName", "traits": { "smithy.api#documentation": "A human-readable name for the benefit application.
" } }, "Description": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationDescription", "traits": { "smithy.api#documentation": "A detailed description of the benefit application and its intended use.
" } }, "BenefitIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the benefit being requested in this application.
", "smithy.api#pattern": "^(arn:.+|ben-[0-9a-z]{14})$", "smithy.api#required": {} } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).
" } }, "BenefitApplicationDetails": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "Detailed information and requirements specific to the benefit being requested.
" } }, "Tags": { "target": "com.amazonaws.partnercentralbenefits#Tags", "traits": { "smithy.api#documentation": "Key-value pairs to categorize and organize the benefit application.
", "smithy.api#length": { "max": 200 } } }, "AssociatedResources": { "target": "com.amazonaws.partnercentralbenefits#Arns", "traits": { "smithy.api#documentation": "AWS resources that are associated with this benefit application.
", "smithy.api#length": { "max": 10 } } }, "PartnerContacts": { "target": "com.amazonaws.partnercentralbenefits#Contacts", "traits": { "smithy.api#documentation": "Contact information for partner representatives responsible for this benefit application.
", "smithy.api#length": { "max": 1 } } }, "FileDetails": { "target": "com.amazonaws.partnercentralbenefits#FileInputDetails", "traits": { "smithy.api#documentation": "Supporting documents and files attached to the benefit application.
", "smithy.api#length": { "max": 30 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#CreateBenefitApplicationOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The unique identifier assigned to the newly created benefit application.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the newly created benefit application.
" } }, "Revision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The initial revision number of the newly created benefit application.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#CreditCode": { "type": "structure", "members": { "AwsAccountId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The AWS account ID that the credit code is associated with or can be applied to.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The monetary value of the credit code.
", "smithy.api#required": {} } }, "AwsCreditCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The actual credit code string that can be redeemed in the AWS billing console.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationStatus", "traits": { "smithy.api#documentation": "The current status of the credit code (e.g., active, redeemed, expired).
", "smithy.api#required": {} } }, "IssuedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the credit code was issued.
", "smithy.api#required": {} } }, "ExpiresAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the credit code expires and can no longer be redeemed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents an AWS credit code that can be applied to an AWS account for billing purposes.
" } }, "com.amazonaws.partnercentralbenefits#CreditCodes": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#CreditCode" } }, "com.amazonaws.partnercentralbenefits#CreditDetails": { "type": "structure", "members": { "AllocatedAmount": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The total amount of credits that have been allocated for this benefit.
", "smithy.api#required": {} } }, "IssuedAmount": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The amount of credits that have actually been issued and are available for use.
", "smithy.api#required": {} } }, "Codes": { "target": "com.amazonaws.partnercentralbenefits#CreditCodes", "traits": { "smithy.api#documentation": "A list of credit codes that have been generated for this benefit allocation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about credit-based benefit fulfillment, including AWS promotional credits.
" } }, "com.amazonaws.partnercentralbenefits#CurrencyCode": { "type": "enum", "members": { "AED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AED" } }, "AMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMD" } }, "ARS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARS" } }, "AUD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUD" } }, "AWG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWG" } }, "AZN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AZN" } }, "BBD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BBD" } }, "BDT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BDT" } }, "BGN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BGN" } }, "BMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BMD" } }, "BND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BND" } }, "BOB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BOB" } }, "BRL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BRL" } }, "BSD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BSD" } }, "BYR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BYR" } }, "BZD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BZD" } }, "CAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CAD" } }, "CHF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHF" } }, "CLP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLP" } }, "CNY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CNY" } }, "COP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COP" } }, "CRC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC" } }, "CZK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CZK" } }, "DKK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DKK" } }, "DOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOP" } }, "EEK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EEK" } }, "EGP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EGP" } }, "EUR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EUR" } }, "GBP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GBP" } }, "GEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GEL" } }, "GHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GHS" } }, "GTQ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GTQ" } }, "GYD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GYD" } }, "HKD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HKD" } }, "HNL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HNL" } }, "HRK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HRK" } }, "HTG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTG" } }, "HUF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HUF" } }, "IDR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDR" } }, "ILS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ILS" } }, "INR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INR" } }, "ISK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISK" } }, "JMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JMD" } }, "JPY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JPY" } }, "KES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KES" } }, "KHR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KHR" } }, "KRW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KRW" } }, "KYD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KYD" } }, "KZT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KZT" } }, "LBP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LBP" } }, "LKR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LKR" } }, "LTL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LTL" } }, "LVL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LVL" } }, "MAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAD" } }, "MNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MNT" } }, "MOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MOP" } }, "MUR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MUR" } }, "MVR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MVR" } }, "MXN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MXN" } }, "MYR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MYR" } }, "NAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NAD" } }, "NGN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NGN" } }, "NIO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NIO" } }, "NOK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOK" } }, "NZD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NZD" } }, "PAB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAB" } }, "PEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PEN" } }, "PHP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHP" } }, "PKR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PKR" } }, "PLN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLN" } }, "PYG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PYG" } }, "QAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QAR" } }, "RON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RON" } }, "RUB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUB" } }, "SAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAR" } }, "SEK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEK" } }, "SGD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SGD" } }, "SIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIT" } }, "SKK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKK" } }, "THB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THB" } }, "TND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TND" } }, "TRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRY" } }, "TTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TTD" } }, "TWD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TWD" } }, "TZS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TZS" } }, "UAH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UAH" } }, "USD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USD" } }, "UYU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UYU" } }, "UZS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UZS" } }, "VND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VND" } }, "XAF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XAF" } }, "XCD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XCD" } }, "XOF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XOF" } }, "XPF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XPF" } }, "ZAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZAR" } } } }, "com.amazonaws.partnercentralbenefits#DisassociateBenefitApplicationResource": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#DisassociateBenefitApplicationResourceInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#DisassociateBenefitApplicationResourceOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Removes the association between an AWS resource and a benefit application.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/DisassociateBenefitApplicationResource" } } }, "com.amazonaws.partnercentralbenefits#DisassociateBenefitApplicationResourceInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "smithy.api#required": {} } }, "BenefitApplicationIdentifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to disassociate the resource from.
", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.partnercentralbenefits#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS resource to disassociate from the benefit application.
", "smithy.api#length": { "min": 0, "max": 1600 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#DisassociateBenefitApplicationResourceOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application after the resource disassociation.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit application after the resource disassociation.
" } }, "Revision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The updated revision number of the benefit application after the resource disassociation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#DisbursementDetails": { "type": "structure", "members": { "DisbursedAmount": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The total amount that has been disbursed for this benefit allocation.
" } }, "IssuanceDetails": { "target": "com.amazonaws.partnercentralbenefits#IssuanceDetail", "traits": { "smithy.api#documentation": "Detailed information about how the disbursement was issued and processed.
" } } }, "traits": { "smithy.api#documentation": "Contains information about disbursement-based benefit fulfillment, such as direct payments or reimbursements.
" } }, "com.amazonaws.partnercentralbenefits#FileDetail": { "type": "structure", "members": { "FileURI": { "target": "com.amazonaws.partnercentralbenefits#FileURI", "traits": { "smithy.api#documentation": "The URI or location where the file is stored.
", "smithy.api#required": {} } }, "BusinessUseCase": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The business purpose or use case that this file supports in the benefit application.
" } }, "FileName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The original name of the uploaded file.
", "smithy.api#length": { "min": 1, "max": 255 } } }, "FileStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The current processing status of the file (e.g., uploaded, processing, approved, rejected).
", "smithy.api#length": { "min": 1, "max": 50 } } }, "FileStatusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason for that particulat file status.
" } }, "FileType": { "target": "com.amazonaws.partnercentralbenefits#FileType", "traits": { "smithy.api#documentation": "The type or category of the file (e.g., document, image, spreadsheet).
" } }, "CreatedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the user who uploaded the file.
", "smithy.api#length": { "min": 1, "max": 255 } } }, "CreatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the file was uploaded.
" } } }, "traits": { "smithy.api#documentation": "Represents detailed information about a file attached to a benefit application.
" } }, "com.amazonaws.partnercentralbenefits#FileDetails": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#FileDetail" } }, "com.amazonaws.partnercentralbenefits#FileInput": { "type": "structure", "members": { "FileURI": { "target": "com.amazonaws.partnercentralbenefits#FileURI", "traits": { "smithy.api#documentation": "The URI or location where the file should be stored or has been uploaded.
", "smithy.api#required": {} } }, "BusinessUseCase": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The business purpose or use case that this file supports in the benefit application.
" } } }, "traits": { "smithy.api#documentation": "Represents input information for uploading a file to a benefit application.
" } }, "com.amazonaws.partnercentralbenefits#FileInputDetails": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#FileInput" } }, "com.amazonaws.partnercentralbenefits#FileType": { "type": "enum", "members": { "DOC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "application/msword" } }, "DOCX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "application/vnd.openxmlformats-officedocument.wordprocessingml.document" } }, "XLSX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } }, "PPTX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "application/vnd.openxmlformats-officedocument.presentationml.presentation" } }, "PDF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "application/pdf" } }, "PNG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "image/png" } }, "JPG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "image/jpeg" } }, "SVG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "image/svg+xml" } }, "CSV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "text/csv" } } } }, "com.amazonaws.partnercentralbenefits#FileURI": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#pattern": "^(s3://|https://).*" } }, "com.amazonaws.partnercentralbenefits#FulfillmentDetails": { "type": "union", "members": { "DisbursementDetails": { "target": "com.amazonaws.partnercentralbenefits#DisbursementDetails", "traits": { "smithy.api#documentation": "Details about disbursement-based fulfillment, if applicable to this benefit allocation.
" } }, "ConsumableDetails": { "target": "com.amazonaws.partnercentralbenefits#ConsumableDetails", "traits": { "smithy.api#documentation": "Details about consumable-based fulfillment, if applicable to this benefit allocation.
" } }, "CreditDetails": { "target": "com.amazonaws.partnercentralbenefits#CreditDetails", "traits": { "smithy.api#documentation": "Details about credit-based fulfillment, if applicable to this benefit allocation.
" } }, "AccessDetails": { "target": "com.amazonaws.partnercentralbenefits#AccessDetails", "traits": { "smithy.api#documentation": "Details about access-based fulfillment, if applicable to this benefit allocation.
" } } }, "traits": { "smithy.api#documentation": "Contains comprehensive information about how a benefit allocation is fulfilled across different fulfillment types.
" } }, "com.amazonaws.partnercentralbenefits#FulfillmentType": { "type": "enum", "members": { "CREDITS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREDITS" } }, "CASH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CASH" } }, "ACCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS" } } } }, "com.amazonaws.partnercentralbenefits#FulfillmentTypes": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentType" } }, "com.amazonaws.partnercentralbenefits#GetBenefit": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#GetBenefitInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#GetBenefitOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Retrieves detailed information about a specific benefit available in the partner catalog.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/GetBenefit" } } }, "com.amazonaws.partnercentralbenefits#GetBenefitAllocation": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#GetBenefitAllocationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#GetBenefitAllocationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Retrieves detailed information about a specific benefit allocation that has been granted to a partner.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/GetBenefitAllocation" } } }, "com.amazonaws.partnercentralbenefits#GetBenefitAllocationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog to query.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit allocation to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#GetBenefitAllocationOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationId", "traits": { "smithy.api#documentation": "The unique identifier of the benefit allocation.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that the benefit allocation belongs to.
" } }, "Arn": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit allocation.
" } }, "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The human-readable name of the benefit allocation.
" } }, "Description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A detailed description of the benefit allocation.
" } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationStatus", "traits": { "smithy.api#documentation": "The current status of the benefit allocation (e.g., active, expired, consumed).
" } }, "StatusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Additional information explaining the current status of the benefit allocation.
" } }, "BenefitApplicationId": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The identifier of the benefit application that resulted in this allocation.
" } }, "BenefitId": { "target": "com.amazonaws.partnercentralbenefits#BenefitId", "traits": { "smithy.api#documentation": "The identifier of the benefit that this allocation is based on.
" } }, "FulfillmentType": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentType", "traits": { "smithy.api#documentation": "The fulfillment type used for this benefit allocation.
" } }, "ApplicableBenefitIds": { "target": "com.amazonaws.partnercentralbenefits#BenefitIdentifiers", "traits": { "smithy.api#documentation": "A list of benefit identifiers that this allocation can be applied to.
" } }, "FulfillmentDetail": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentDetails", "traits": { "smithy.api#documentation": "Detailed information about how the benefit allocation is fulfilled.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit allocation was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit allocation was last updated.
" } }, "StartsAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit allocation becomes active and usable.
" } }, "ExpiresAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit allocation expires and is no longer usable.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#GetBenefitApplication": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#GetBenefitApplicationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#GetBenefitApplicationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Retrieves detailed information about a specific benefit application.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/GetBenefitApplication" } } }, "com.amazonaws.partnercentralbenefits#GetBenefitApplicationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog to query.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#GetBenefitApplicationOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application.
" } }, "Arn": { "target": "com.amazonaws.partnercentralbenefits#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit application.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that the benefit application belongs to.
" } }, "BenefitId": { "target": "com.amazonaws.partnercentralbenefits#BenefitId", "traits": { "smithy.api#documentation": "The identifier of the benefit being requested in this application.
" } }, "Name": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationName", "traits": { "smithy.api#documentation": "The human-readable name of the benefit application.
" } }, "Description": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationDescription", "traits": { "smithy.api#documentation": "A detailed description of the benefit application.
" } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "The fulfillment types requested for this benefit application.
" } }, "BenefitApplicationDetails": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "Detailed information and requirements specific to the benefit being requested.
" } }, "Programs": { "target": "com.amazonaws.partnercentralbenefits#Programs", "traits": { "smithy.api#documentation": "The AWS partner programs associated with this benefit application.
" } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationStatus", "traits": { "smithy.api#documentation": "The current processing status of the benefit application.
" } }, "Stage": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationStage", "traits": { "smithy.api#documentation": "The current stage in the benefit application processing workflow.
" } }, "StatusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Additional information explaining the current status of the benefit application.
", "smithy.api#length": { "max": 1000 } } }, "StatusReasonCode": { "target": "com.amazonaws.partnercentralbenefits#StatusReasonCode", "traits": { "smithy.api#deprecated": { "message": "This field is no longer used", "since": "Nov 08 2025" }, "smithy.api#documentation": "A standardized code representing the reason for the current status.
" } }, "StatusReasonCodes": { "target": "com.amazonaws.partnercentralbenefits#StatusReasonCodes", "traits": { "smithy.api#documentation": "The list of standardized codes representing the reason for the current status.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit application was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the benefit application was last updated.
" } }, "Revision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The current revision number of the benefit application.
" } }, "AssociatedResources": { "target": "com.amazonaws.partnercentralbenefits#Arns", "traits": { "smithy.api#documentation": "AWS resources that are associated with this benefit application.
", "smithy.api#length": { "max": 10 } } }, "PartnerContacts": { "target": "com.amazonaws.partnercentralbenefits#Contacts", "traits": { "smithy.api#documentation": "Contact information for partner representatives responsible for this benefit application.
" } }, "FileDetails": { "target": "com.amazonaws.partnercentralbenefits#FileDetails", "traits": { "smithy.api#documentation": "Supporting documents and files attached to the benefit application.
", "smithy.api#length": { "max": 30 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#GetBenefitInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog to query.
", "smithy.api#required": {} } }, "Identifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the benefit to retrieve.
", "smithy.api#pattern": "^(arn:.+|ben-[0-9a-z]{14})$", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#GetBenefitOutput": { "type": "structure", "members": { "Id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the benefit.
", "smithy.api#pattern": "^ben-[0-9a-z]{14}$" } }, "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that the benefit belongs to.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the benefit.
" } }, "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The human-readable name of the benefit.
", "smithy.api#length": { "min": 1, "max": 100 } } }, "Description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A detailed description of the benefit and its purpose.
", "smithy.api#length": { "max": 1000 } } }, "Programs": { "target": "com.amazonaws.partnercentralbenefits#Programs", "traits": { "smithy.api#documentation": "The AWS partner programs that this benefit is associated with.
" } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "The available fulfillment types for this benefit (e.g., credits, access, disbursement).
" } }, "BenefitRequestSchema": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The schema definition that describes the required fields for requesting this benefit.
" } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitStatus", "traits": { "smithy.api#documentation": "The current status of the benefit (e.g., active, inactive, deprecated).
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#InternalServerException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the internal server error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Thrown when an unexpected error occurs on the server side during request processing.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.partnercentralbenefits#IssuanceDetail": { "type": "structure", "members": { "IssuanceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier for this specific issuance.
" } }, "IssuanceAmount": { "target": "com.amazonaws.partnercentralbenefits#MonetaryValue", "traits": { "smithy.api#documentation": "The monetary amount or value that was issued in this specific issuance.
" } }, "IssuedAt": { "target": "com.amazonaws.partnercentralbenefits#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when this specific issuance was processed.
" } } }, "traits": { "smithy.api#documentation": "Represents detailed information about a specific issuance of benefit value.
" } }, "com.amazonaws.partnercentralbenefits#ListBenefitAllocations": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#ListBenefitAllocationsInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#ListBenefitAllocationsOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes" ], "smithy.api#documentation": "Retrieves a paginated list of benefit allocations based on specified filter criteria.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/ListBenefitAllocations" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "BenefitAllocationSummaries" } } }, "com.amazonaws.partnercentralbenefits#ListBenefitAllocationsInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier to filter benefit allocations by catalog.
", "smithy.api#required": {} } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "Filter benefit allocations by specific fulfillment types.
", "smithy.api#length": { "min": 0, "max": 2 } } }, "BenefitIdentifiers": { "target": "com.amazonaws.partnercentralbenefits#BenefitIdentifiers", "traits": { "smithy.api#documentation": "Filter benefit allocations by specific benefit identifiers.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "BenefitApplicationIdentifiers": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifierList", "traits": { "smithy.api#documentation": "Filter benefit allocations by specific benefit application identifiers.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationStatusList", "traits": { "smithy.api#documentation": "Filter benefit allocations by their current status.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "MaxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of benefit allocations to return in a single response.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token to retrieve the next set of results from a previous request.
", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\s\\S]*$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#ListBenefitAllocationsOutput": { "type": "structure", "members": { "BenefitAllocationSummaries": { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocationSummaries", "traits": { "smithy.api#documentation": "A list of benefit allocation summaries matching the specified criteria.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token to retrieve the next set of results, if more results are available.
", "smithy.api#length": { "max": 2048 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#ListBenefitApplications": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#ListBenefitApplicationsInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#ListBenefitApplicationsOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs" ], "smithy.api#documentation": "Retrieves a paginated list of benefit applications based on specified filter criteria.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/ListBenefitApplications" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "BenefitApplicationSummaries" } } }, "com.amazonaws.partnercentralbenefits#ListBenefitApplicationsInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier to filter benefit applications by catalog.
", "smithy.api#required": {} } }, "Programs": { "target": "com.amazonaws.partnercentralbenefits#Programs", "traits": { "smithy.api#documentation": "Filter benefit applications by specific AWS partner programs.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "Filter benefit applications by specific fulfillment types.
", "smithy.api#length": { "min": 0, "max": 2 } } }, "BenefitIdentifiers": { "target": "com.amazonaws.partnercentralbenefits#BenefitIdentifiers", "traits": { "smithy.api#documentation": "Filter benefit applications by specific benefit identifiers.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#Statuses", "traits": { "smithy.api#documentation": "Filter benefit applications by their current processing status.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "Stages": { "target": "com.amazonaws.partnercentralbenefits#Stages", "traits": { "smithy.api#documentation": "Filter benefit applications by their current processing stage.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "AssociatedResources": { "target": "com.amazonaws.partnercentralbenefits#AssociatedResources", "traits": { "smithy.api#deprecated": { "message": "This field is no longer used.", "since": "Oct 08 2025" }, "smithy.api#documentation": "Filter benefit applications by associated AWS resources.
" } }, "AssociatedResourceArns": { "target": "com.amazonaws.partnercentralbenefits#Arns", "traits": { "smithy.api#documentation": "Filter benefit applications by specific AWS resource ARNs.
" } }, "MaxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of benefit applications to return in a single response.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token to retrieve the next set of results from a previous request.
", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\s\\S]*$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#ListBenefitApplicationsOutput": { "type": "structure", "members": { "BenefitApplicationSummaries": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationSummaries", "traits": { "smithy.api#documentation": "A list of benefit application summaries matching the specified criteria.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token to retrieve the next set of results, if more results are available.
", "smithy.api#length": { "max": 2048 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#ListBenefits": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#ListBenefitsInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#ListBenefitsOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:FulfillmentTypes", "partnercentral:Programs", "partnercentral:Catalog" ], "smithy.api#documentation": "Retrieves a paginated list of available benefits based on specified filter criteria.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/ListBenefits" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "BenefitSummaries" }, "smithy.test#smokeTests": [ { "id": "ListBenefitsSuccess", "params": { "Catalog": "AWS", "MaxResults": 10 }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.partnercentralbenefits#ListBenefitsInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier to filter benefits by catalog.
", "smithy.api#required": {} } }, "Programs": { "target": "com.amazonaws.partnercentralbenefits#Programs", "traits": { "smithy.api#documentation": "Filter benefits by specific AWS partner programs.
", "smithy.api#length": { "min": 0, "max": 1 } } }, "FulfillmentTypes": { "target": "com.amazonaws.partnercentralbenefits#FulfillmentTypes", "traits": { "smithy.api#documentation": "Filter benefits by specific fulfillment types.
", "smithy.api#length": { "min": 0, "max": 2 } } }, "Status": { "target": "com.amazonaws.partnercentralbenefits#BenefitStatuses", "traits": { "smithy.api#documentation": "Filter benefits by their current status.
", "smithy.api#length": { "min": 0, "max": 2 } } }, "MaxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of benefits to return in a single response.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token to retrieve the next set of results from a previous request.
", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\s\\S]*$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#ListBenefitsOutput": { "type": "structure", "members": { "BenefitSummaries": { "target": "com.amazonaws.partnercentralbenefits#BenefitSummaries", "traits": { "smithy.api#documentation": "A list of benefit summaries matching the specified criteria.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token to retrieve the next set of results, if more results are available.
", "smithy.api#length": { "max": 2048 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.partnercentralbenefits#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Retrieves all tags associated with a specific resource.
", "smithy.api#http": { "uri": "/ListTagsForResource", "method": "POST", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralbenefits#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.partnercentralbenefits#TaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to list tags for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.partnercentralbenefits#Tags", "traits": { "smithy.api#documentation": "A list of key-value pairs representing the tags associated with the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#MonetaryValue": { "type": "structure", "members": { "Amount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The numeric amount of the monetary value.
", "smithy.api#required": {} } }, "CurrencyCode": { "target": "com.amazonaws.partnercentralbenefits#CurrencyCode", "traits": { "smithy.api#documentation": "The ISO 4217 currency code (e.g., USD, EUR) for the monetary amount.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a monetary amount with its associated currency.
" } }, "com.amazonaws.partnercentralbenefits#PartnerCentralBenefitsService": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.partnercentralbenefits#AmendBenefitApplication" }, { "target": "com.amazonaws.partnercentralbenefits#AssociateBenefitApplicationResource" }, { "target": "com.amazonaws.partnercentralbenefits#CancelBenefitApplication" }, { "target": "com.amazonaws.partnercentralbenefits#CreateBenefitApplication" }, { "target": "com.amazonaws.partnercentralbenefits#DisassociateBenefitApplicationResource" }, { "target": "com.amazonaws.partnercentralbenefits#GetBenefit" }, { "target": "com.amazonaws.partnercentralbenefits#GetBenefitAllocation" }, { "target": "com.amazonaws.partnercentralbenefits#GetBenefitApplication" }, { "target": "com.amazonaws.partnercentralbenefits#ListBenefitAllocations" }, { "target": "com.amazonaws.partnercentralbenefits#ListBenefitApplications" }, { "target": "com.amazonaws.partnercentralbenefits#ListBenefits" }, { "target": "com.amazonaws.partnercentralbenefits#ListTagsForResource" }, { "target": "com.amazonaws.partnercentralbenefits#RecallBenefitApplication" }, { "target": "com.amazonaws.partnercentralbenefits#SubmitBenefitApplication" }, { "target": "com.amazonaws.partnercentralbenefits#TagResource" }, { "target": "com.amazonaws.partnercentralbenefits#UntagResource" }, { "target": "com.amazonaws.partnercentralbenefits#UpdateBenefitApplication" } ], "resources": [ { "target": "com.amazonaws.partnercentralbenefits#Benefit" }, { "target": "com.amazonaws.partnercentralbenefits#BenefitAllocation" }, { "target": "com.amazonaws.partnercentralbenefits#BenefitApplication" } ], "traits": { "aws.api#service": { "sdkId": "PartnerCentral Benefits", "endpointPrefix": "partnercentral-benefits", "arnNamespace": "partnercentral", "cloudTrailEventSource": "partnercentral-benefits.amazonaws.com" }, "aws.auth#sigv4": { "name": "partnercentral-benefits" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#defineConditionKeys": { "partnercentral:Catalog": { "type": "String", "documentation": "Filters access by the Catalog. Accepted values: [AWS, Sandbox]", "relativeDocumentation": "page.html#Catalog" }, "partnercentral:Programs": { "type": "ArrayOfString", "documentation": "Filters access by tags assigned to a program", "relativeDocumentation": "page.html#Programs" }, "partnercentral:FulfillmentTypes": { "type": "ArrayOfString", "documentation": "Filters access by tags assigned to a specific fulfilmentType", "relativeDocumentation": "page.html#FulfillmentTypes" }, "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags that are passed in the request", "externalDocumentation": "https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags associated with the resource", "externalDocumentation": "https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by the tag keys that are passed in the request", "externalDocumentation": "https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "AWS Partner Central Benefits Service provides APIs for managing partner benefits, applications, and allocations within the AWS Partner Network ecosystem.
", "smithy.api#title": "Partner Central Benefits API", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://partnercentral-benefits-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://partnercentral-benefits.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://partnercentral-benefits-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://partnercentral-benefits.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://partnercentral-benefits-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://partnercentral-benefits.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://partnercentral-benefits-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://partnercentral-benefits.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://partnercentral-benefits-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://partnercentral-benefits.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.partnercentralbenefits#Program": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "com.amazonaws.partnercentralbenefits#Programs": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#Program" } }, "com.amazonaws.partnercentralbenefits#RecallBenefitApplication": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#RecallBenefitApplicationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#RecallBenefitApplicationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Recalls a submitted benefit application, returning it to draft status for further modifications.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/RecallBenefitApplication" } } }, "com.amazonaws.partnercentralbenefits#RecallBenefitApplicationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "smithy.api#required": {} } }, "ClientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotent processing of the recall request.
" } }, "Identifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to recall.
", "smithy.api#required": {} } }, "Reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A descriptive reason explaining why the benefit application is being recalled.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#RecallBenefitApplicationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the resource not found error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Thrown when the requested resource cannot be found or does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.partnercentralbenefits#ResourceType": { "type": "enum", "members": { "OPPORTUNITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPPORTUNITY" } }, "BENEFIT_ALLOCATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BENEFIT_ALLOCATION" } } } }, "com.amazonaws.partnercentralbenefits#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the service quota exceeded error.
", "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the resource that would exceed the quota.
", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource that would exceed the quota.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code identifying the specific quota that would be exceeded.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Thrown when the request would exceed the service quotas or limits for the account.
", "smithy.api#error": "client", "smithy.api#httpError": 402, "smithy.api#retryable": {} } }, "com.amazonaws.partnercentralbenefits#Stages": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationStage" } }, "com.amazonaws.partnercentralbenefits#StatusReasonCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.partnercentralbenefits#StatusReasonCodes": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#StatusReasonCode" }, "traits": { "smithy.api#documentation": "List of StatusReasonCodes", "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.partnercentralbenefits#Statuses": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationStatus" } }, "com.amazonaws.partnercentralbenefits#SubmitBenefitApplication": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#SubmitBenefitApplicationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#SubmitBenefitApplicationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Submits a benefit application for review and processing by AWS.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/SubmitBenefitApplication" } } }, "com.amazonaws.partnercentralbenefits#SubmitBenefitApplicationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to submit.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#SubmitBenefitApplicationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.partnercentralbenefits#TagKey", "traits": { "smithy.api#documentation": "The tag key, which acts as a category or label for the tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.partnercentralbenefits#TagValue", "traits": { "smithy.api#documentation": "The tag value, which provides additional information or context for the tag key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a key-value pair used for categorizing and organizing AWS resources.
" } }, "com.amazonaws.partnercentralbenefits#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.partnercentralbenefits#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.partnercentralbenefits#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#TagResourceRequest" }, "output": { "target": "com.amazonaws.partnercentralbenefits#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}", "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "Adds or updates tags for a specified resource.
", "smithy.api#http": { "uri": "/TagResource", "method": "POST", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralbenefits#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.partnercentralbenefits#TaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to add tags to.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.partnercentralbenefits#Tags", "traits": { "smithy.api#documentation": "A list of key-value pairs to add as tags to the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#TagValue": { "type": "string", "traits": { "smithy.api#length": { "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.partnercentralbenefits#TaggableResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:partnercentral:[\\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" } }, "com.amazonaws.partnercentralbenefits#Tags": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#Tag" } }, "com.amazonaws.partnercentralbenefits#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the throttling error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Thrown when the request rate exceeds the allowed limits and the request is being throttled.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.partnercentralbenefits#Timestamp": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.partnercentralbenefits#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#UntagResourceRequest" }, "output": { "target": "com.amazonaws.partnercentralbenefits#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Removes specified tags from a resource.
", "smithy.api#http": { "uri": "/UntagResource", "method": "POST", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralbenefits#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.partnercentralbenefits#TaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to remove tags from.
", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.partnercentralbenefits#TagKeyList", "traits": { "smithy.api#documentation": "A list of tag keys to remove from the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#UpdateBenefitApplication": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralbenefits#UpdateBenefitApplicationInput" }, "output": { "target": "com.amazonaws.partnercentralbenefits#UpdateBenefitApplicationOutput" }, "errors": [ { "target": "com.amazonaws.partnercentralbenefits#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralbenefits#ConflictException" }, { "target": "com.amazonaws.partnercentralbenefits#InternalServerException" }, { "target": "com.amazonaws.partnercentralbenefits#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralbenefits#ThrottlingException" }, { "target": "com.amazonaws.partnercentralbenefits#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:FulfillmentTypes", "partnercentral:Programs", "aws:ResourceTag/${TagKey}" ], "smithy.api#documentation": "Updates an existing benefit application with new information while maintaining revision control.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/UpdateBenefitApplication" } } }, "com.amazonaws.partnercentralbenefits#UpdateBenefitApplicationInput": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralbenefits#CatalogName", "traits": { "smithy.api#documentation": "The catalog identifier that specifies which benefit catalog the application belongs to.
", "smithy.api#required": {} } }, "ClientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier to ensure idempotent processing of the update request.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[!-~]{1,64}$", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationName", "traits": { "smithy.api#documentation": "The updated human-readable name for the benefit application.
" } }, "Description": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationDescription", "traits": { "smithy.api#documentation": "The updated detailed description of the benefit application.
" } }, "Identifier": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the benefit application to update.
", "smithy.api#required": {} } }, "Revision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The current revision number of the benefit application to ensure optimistic concurrency control.
", "smithy.api#required": {} } }, "BenefitApplicationDetails": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "Updated detailed information and requirements specific to the benefit being requested.
" } }, "PartnerContacts": { "target": "com.amazonaws.partnercentralbenefits#Contacts", "traits": { "smithy.api#documentation": "Updated contact information for partner representatives responsible for this benefit application.
", "smithy.api#length": { "max": 1 } } }, "FileDetails": { "target": "com.amazonaws.partnercentralbenefits#FileInputDetails", "traits": { "smithy.api#documentation": "Updated supporting documents and files attached to the benefit application.
", "smithy.api#length": { "max": 30 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.partnercentralbenefits#UpdateBenefitApplicationOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralbenefits#BenefitApplicationId", "traits": { "smithy.api#documentation": "The unique identifier of the updated benefit application.
" } }, "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated benefit application.
" } }, "Revision": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The new revision number of the benefit application after the update.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.partnercentralbenefits#ValidationException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the validation error.
", "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.partnercentralbenefits#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The reason for the validation failure.
", "smithy.api#required": {} } }, "FieldList": { "target": "com.amazonaws.partnercentralbenefits#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "A list of fields that failed validation.
" } } }, "traits": { "smithy.api#documentation": "Thrown when the request contains invalid parameters or fails input validation requirements.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.partnercentralbenefits#ValidationExceptionErrorCode": { "type": "enum", "members": { "REQUIRED_FIELD_MISSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUIRED_FIELD_MISSING" } }, "INVALID_ENUM_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ENUM_VALUE" } }, "INVALID_STRING_FORMAT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_STRING_FORMAT" } }, "INVALID_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_VALUE" } }, "NOT_ENOUGH_VALUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_ENOUGH_VALUES" } }, "TOO_MANY_VALUES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOO_MANY_VALUES" } }, "INVALID_RESOURCE_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_RESOURCE_STATE" } }, "DUPLICATE_KEY_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUPLICATE_KEY_VALUE" } }, "VALUE_OUT_OF_RANGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALUE_OUT_OF_RANGE" } }, "ACTION_NOT_PERMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_NOT_PERMITTED" } } } }, "com.amazonaws.partnercentralbenefits#ValidationExceptionField": { "type": "structure", "members": { "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the field that failed validation.
", "smithy.api#required": {} } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A detailed message explaining why the field validation failed.
", "smithy.api#required": {} } }, "Code": { "target": "com.amazonaws.partnercentralbenefits#ValidationExceptionErrorCode", "traits": { "smithy.api#documentation": "An error code explaining why the field validation failed.
" } } }, "traits": { "smithy.api#documentation": "Represents a field-specific validation error with detailed information.
" } }, "com.amazonaws.partnercentralbenefits#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralbenefits#ValidationExceptionField" } }, "com.amazonaws.partnercentralbenefits#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknownOperation" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cannotParse" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fieldValidationFailed" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "other" } }, "BUSINESS_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUSINESS_VALIDATION_FAILED" } } } } } }