GetSubscriptionState - AWS Shield Advanced

GetSubscriptionState

Returns the SubscriptionState, either Active or Inactive.

Response Syntax

{ "SubscriptionState": "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.

SubscriptionState

The status of the subscription.

Type: String

Valid Values: ACTIVE | INACTIVE

Errors

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

InternalErrorException

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: