Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetAgreementEntitlements

Obtains details about the entitlements of an agreement.

Request Syntax


{
   "agreementId": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

agreementId

The unique identifier of the agreement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

Required: Yes

maxResults

The maximum number of agreement entitlements to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

nextToken

A token to specify where to start pagination.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [a-zA-Z0-9+/=_-]+

Required: No

Response Syntax


{
   "agreementEntitlements": [ 
      { 
         "licenseArn": "string",
         "registrationToken": "string",
         "resource": { 
            "id": "string",
            "type": "string"
         },
         "status": "string",
         "statusReasonCode": "string",
         "type": "string"
      }
   ],
   "nextToken": "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.

agreementEntitlements

A list of agreement entitlements which are part of the latest agreement.

Type: Array of AgreementEntitlement objects

nextToken

The token used for pagination. The field is null if there are no more results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: [a-zA-Z0-9+/=_-]+

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

User does not have sufficient access to perform this action.

message: Description of the error.
reason: The reason for the access denied exception.
requestId: The unique identifier for the error.

HTTP Status Code: 400

InternalServerException

Unexpected error during processing of request.

message: Description of the error.
requestId: The unique identifier for the error.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

message: Description of the error.
requestId: The unique identifier for the error.
resourceId: The unique identifier for the resource.
resourceType: The type of resource.

HTTP Status Code: 400

ThrottlingException

Request was denied due to request throttling.

message: Description of the error.
requestId: The unique identifier for the error.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service.

fields: The fields associated with the error.
message: Description of the error.
reason: The reason associated with the error.
requestId: The unique identifier associated with the error.

HTTP Status Code: 400

Examples

Sample request

This example illustrates one usage of GetAgreementEntitlements.


{
    "agreementId": "agmt-EXAMPLE0aa6-4e42-8715-6a1EXAMPLE95"
}

Sample response

This example illustrates one usage of GetAgreementEntitlements.


{
    "agreementEntitlements": [
        {
            "resource": {
                "id": "prod-EXAMPLE",
                "type": "SaaSProduct"
            },
            "status": "PROVISIONED",
            "statusReasonCode": "AGREEMENT_ACTIVE",
            "type": "AWS::Marketplace::Usage",
            "registrationToken": "EXAMPLE-registration-token",
            "licenseArn": "arn:aws:license-manager::123456789012:license/lic-EXAMPLE01234abcd"
        },
        {
            "resource": {
                "id": "prod-EXAMPLE",
                "type": "SaaSProduct"
            },
            "status": "PENDING",
            "statusReasonCode": "PROVISIONING_IN_PROGRESS",
            "type": "AWS::Marketplace::Discount",
            "registrationToken": null,
            "licenseArn": null
        }
    ],
    "nextToken": null
}