UpdateSubscriptionCommand

Suggest an Edit

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ShieldClient, UpdateSubscriptionCommand } from "@aws-sdk/client-shield"; // ES Modules import
// const { ShieldClient, UpdateSubscriptionCommand } = require("@aws-sdk/client-shield"); // CommonJS import
const client = new ShieldClient(config);
const input = { // UpdateSubscriptionRequest
  AutoRenew: "ENABLED" || "DISABLED",
};
const command = new UpdateSubscriptionCommand(input);
const response = await client.send(command);
// {};

UpdateSubscriptionCommand Input

See UpdateSubscriptionCommandInput for more details

Parameter
Type
Description
AutoRenew
AutoRenew | undefined

When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

UpdateSubscriptionCommand Output

See UpdateSubscriptionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InternalErrorException
server

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

InvalidParameterException
client

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

LockedSubscriptionException
client

You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

OptimisticLockException
client

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

ResourceNotFoundException
client

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

ShieldServiceException
Base exception class for all service exceptions from Shield service.