SSM / Client / describe_activations

describe_activations

SSM.Client.describe_activations(**kwargs)

Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.

See also: AWS API Documentation

Request Syntax

response = client.describe_activations(
    Filters=[
        {
            'FilterKey': 'ActivationIds'|'DefaultInstanceName'|'IamRole',
            'FilterValues': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Filters (list) –

  A filter to view information about your activations.

  • (dict) –

    Filter for the DescribeActivation API.

    • FilterKey (string) –

      The name of the filter.

    • FilterValues (list) –

      The filter values.

      • (string) –

• MaxResults (integer) – The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

• NextToken (string) – A token to start the list. Use this token to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'ActivationList': [
        {
            'ActivationId': 'string',
            'Description': 'string',
            'DefaultInstanceName': 'string',
            'IamRole': 'string',
            'RegistrationLimit': 123,
            'RegistrationsCount': 123,
            'ExpirationDate': datetime(2015, 1, 1),
            'Expired': True|False,
            'CreatedDate': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ActivationList (list) –

    A list of activations for your Amazon Web Services account.

    • (dict) –

      An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with Amazon Web Services Systems Manager is called a managed node.

      • ActivationId (string) –

        The ID created by Systems Manager when you submitted the activation.

      • Description (string) –

        A user defined description of the activation.

      • DefaultInstanceName (string) –

        A name for the managed node when it is created.

      • IamRole (string) –

        The Identity and Access Management (IAM) role to assign to the managed node.

      • RegistrationLimit (integer) –

        The maximum number of managed nodes that can be registered using this activation.

      • RegistrationsCount (integer) –

        The number of managed nodes already registered with this activation.

      • ExpirationDate (datetime) –

        The date when this activation can no longer be used to register managed nodes.

      • Expired (boolean) –

        Whether or not the activation is expired.

      • CreatedDate (datetime) –

        The date the activation was created.

      • Tags (list) –

        Tags assigned to the activation.

        • (dict) –

          Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

          • Key (string) –

            The name of the tag.

          • Value (string) –

            The value of the tag.

  • NextToken (string) –

    The token for the next set of items to return. Use this token to get the next set of results.

Exceptions

• SSM.Client.exceptions.InvalidFilter

• SSM.Client.exceptions.InvalidNextToken

• SSM.Client.exceptions.InternalServerError