AgreementService / Client / get_agreement_entitlements

get_agreement_entitlements

AgreementService.Client.get_agreement_entitlements(**kwargs)

Obtains details about the entitlements of an agreement.

See also: AWS API Documentation

Request Syntax

response = client.get_agreement_entitlements(
    agreementId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • agreementId (string) –

    [REQUIRED]

    The unique identifier of the agreement.

  • maxResults (integer) – The maximum number of agreement entitlements to return in the response.

  • nextToken (string) – A token to specify where to start pagination.

Return type:

dict

Returns:

Response Syntax

{
    'agreementEntitlements': [
        {
            'resource': {
                'id': 'string',
                'type': 'string'
            },
            'type': 'string',
            'registrationToken': 'string',
            'status': 'PROVISIONED'|'SCHEDULED'|'PENDING'|'FAILED'|'DEPROVISIONED',
            'statusReasonCode': 'PROVISIONING_IN_PROGRESS'|'FUTURE_START_DATE'|'INVALID_PAYMENT_INSTRUMENT'|'INCOMPATIBLE_CURRENCY'|'ACCOUNT_SUSPENDED'|'UNSUPPORTED_OPERATION'|'AGREEMENT_INACTIVE'|'AGREEMENT_ACTIVE'|'PRODUCT_RESTRICTED',
            'licenseArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • agreementEntitlements (list) –

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

      • (dict) –

        Represents an entitlement associated with an agreement, including the provisioning status, resource, and type.

        • resource (dict) –

          The resource that the entitlement is provisioned to, such as a product.

          • id (string) –

            The unique identifier of the resource.

            Note

            We mention the term resource, which is most commonly a product, so a resourceId is also a productId.

          • type (string) –

            Type of the resource, which is the product (for example, SaaSProduct, AmiProduct, ContainerProduct).

        • type (string) –

          The type of entitlement.

        • registrationToken (string) –

          A short-lived token required by acceptors to register their account with the product provider. The token is only valid for 30 minutes after creation and is only applicable for purchase agreements.

        • status (string) –

          The current state of an entitlement.

        • statusReasonCode (string) –

          Provides more information about the status of an entitlement.

        • licenseArn (string) –

          The Amazon Resource Name (ARN) of the AWS License Manager license associated with the entitlement.

    • nextToken (string) –

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

Exceptions