Shield / Client / get_subscription_state

get_subscription_state#

Shield.Client.get_subscription_state()#

Returns the SubscriptionState, either Active or Inactive.

See also: AWS API Documentation

Request Syntax

response = client.get_subscription_state()
Return type:

dict

Returns:

Response Syntax

{
    'SubscriptionState': 'ACTIVE'|'INACTIVE'
}

Response Structure

  • (dict) –

    • SubscriptionState (string) –

      The status of the subscription.

Exceptions

  • Shield.Client.exceptions.InternalErrorException