GetBenefit
Retrieves detailed information about a specific benefit available in the partner catalog.
Request Syntax
{
"Catalog": "string",
"Identifier": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- Catalog
-
The catalog identifier that specifies which benefit catalog to query.
Type: String
Pattern:
[A-Za-z0-9_-]+Required: Yes
- Identifier
-
The unique identifier of the benefit to retrieve.
Type: String
Pattern:
(arn:.+|ben-[0-9a-z]{14})Required: Yes
Response Syntax
{
"Arn": "string",
"BenefitRequestSchema": JSON value,
"Catalog": "string",
"Description": "string",
"FulfillmentTypes": [ "string" ],
"Id": "string",
"Name": "string",
"Programs": [ "string" ],
"Status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) of the benefit.
Type: String
- BenefitRequestSchema
-
The schema definition that describes the required fields for requesting this benefit.
Type: JSON value
- Catalog
-
The catalog identifier that the benefit belongs to.
Type: String
Pattern:
[A-Za-z0-9_-]+ - Description
-
A detailed description of the benefit and its purpose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
- FulfillmentTypes
-
The available fulfillment types for this benefit (e.g., credits, access, disbursement).
Type: Array of strings
Valid Values:
CREDITS | CASH | ACCESS - Id
-
The unique identifier of the benefit.
Type: String
Pattern:
ben-[0-9a-z]{14} - Name
-
The human-readable name of the benefit.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- Programs
-
The AWS partner programs that this benefit is associated with.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z0-9_-]+ - Status
-
The current status of the benefit (e.g., active, inactive, deprecated).
Type: String
Valid Values:
ACTIVE | INACTIVE
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Thrown when the caller does not have sufficient permissions to perform the requested operation.
- Message
-
A message describing the access denial.
HTTP Status Code: 400
- InternalServerException
-
Thrown when an unexpected error occurs on the server side during request processing.
- Message
-
A message describing the internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
Thrown when the requested resource cannot be found or does not exist.
- Message
-
A message describing the resource not found error.
HTTP Status Code: 400
- ThrottlingException
-
Thrown when the request rate exceeds the allowed limits and the request is being throttled.
- Message
-
A message describing the throttling error.
HTTP Status Code: 400
- ValidationException
-
Thrown when the request contains invalid parameters or fails input validation requirements.
- FieldList
-
A list of fields that failed validation.
- Message
-
A message describing the validation error.
- Reason
-
The reason for the validation failure.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
