shield

package module
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 27 Imported by: 52

Documentation

Overview

Package shield provides the API client, operations, and parameter types for AWS Shield.

AWS Shield Advanced This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

Index

Constants

View Source 
const ServiceAPIVersion = "2016-06-02"
View Source 
const ServiceID = "Shield"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AssociateDRTLogBucketInput 

type AssociateDRTLogBucketInput struct {

	// The Amazon S3 bucket that contains your AWS WAF logs.
	//
	// This member is required.
	LogBucket *string
}

type AssociateDRTLogBucketOutput 

type AssociateDRTLogBucketOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateDRTRoleInput 

type AssociateDRTRoleInput struct {

	// The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS
	// account. Prior to making the AssociateDRTRole request, you must attach the
	// AWSShieldDRTAccessPolicy
	// (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy)
	// managed policy to this role. For more information see Attaching and Detaching
	// IAM Policies
	// (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html).
	//
	// This member is required.
	RoleArn *string
}

type AssociateDRTRoleOutput 

type AssociateDRTRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateHealthCheckInput 

type AssociateHealthCheckInput struct {

	// The Amazon Resource Name (ARN) of the health check to associate with the
	// protection.
	//
	// This member is required.
	HealthCheckArn *string

	// The unique identifier (ID) for the Protection object to add the health check
	// association to.
	//
	// This member is required.
	ProtectionId *string
}

type AssociateHealthCheckOutput 

type AssociateHealthCheckOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateProactiveEngagementDetailsInput 

type AssociateProactiveEngagementDetailsInput struct {

	// A list of email addresses and phone numbers that the DDoS Response Team (DRT)
	// can use to contact you for escalations to the DRT and to initiate proactive
	// customer support. To enable proactive engagement, the contact list must include
	// at least one phone number. The contacts that you provide here replace any
	// contacts that were already defined. If you already have contacts defined and
	// want to use them, retrieve the list using DescribeEmergencyContactSettings and
	// then provide it here.
	//
	// This member is required.
	EmergencyContactList []types.EmergencyContact
}

type AssociateProactiveEngagementDetailsOutput 

type AssociateProactiveEngagementDetailsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Shield.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateDRTLogBucket 

func (c *Client) AssociateDRTLogBucket(ctx context.Context, params *AssociateDRTLogBucketInput, optFns ...func(*Options)) (*AssociateDRTLogBucketOutput, error)

Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription. To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

func (*Client) AssociateDRTRole 

func (c *Client) AssociateDRTRole(ctx context.Context, params *AssociateDRTRoleInput, optFns ...func(*Options)) (*AssociateDRTRoleOutput, error)

Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs. You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy) managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html). The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html). The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you. You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html). To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

func (*Client) AssociateHealthCheck 

func (c *Client) AssociateHealthCheck(ctx context.Context, params *AssociateHealthCheckInput, optFns ...func(*Options)) (*AssociateHealthCheckOutput, error)

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

func (*Client) AssociateProactiveEngagementDetails 

func (c *Client) AssociateProactiveEngagementDetails(ctx context.Context, params *AssociateProactiveEngagementDetailsInput, optFns ...func(*Options)) (*AssociateProactiveEngagementDetailsOutput, error)

Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use. You must provide at least one phone number in the emergency contact list. After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement. This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support. The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.

func (*Client) CreateProtection 

func (c *Client) CreateProtection(ctx context.Context, params *CreateProtectionInput, optFns ...func(*Options)) (*CreateProtectionOutput, error)

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone. You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console (https://console.aws.amazon.com/waf/). For more information see Getting Started with AWS Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) and Add AWS Shield Advanced Protection to more AWS Resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html).

func (*Client) CreateProtectionGroup added in v0.30.0 

func (c *Client) CreateProtectionGroup(ctx context.Context, params *CreateProtectionGroupInput, optFns ...func(*Options)) (*CreateProtectionGroupOutput, error)

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

func (*Client) CreateSubscription 

func (c *Client) CreateSubscription(ctx context.Context, params *CreateSubscriptionInput, optFns ...func(*Options)) (*CreateSubscriptionOutput, error)

Activates AWS Shield Advanced for an account. When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

func (*Client) DeleteProtection 

func (c *Client) DeleteProtection(ctx context.Context, params *DeleteProtectionInput, optFns ...func(*Options)) (*DeleteProtectionOutput, error)

Deletes an AWS Shield Advanced Protection.

func (*Client) DeleteProtectionGroup added in v0.30.0 

func (c *Client) DeleteProtectionGroup(ctx context.Context, params *DeleteProtectionGroupInput, optFns ...func(*Options)) (*DeleteProtectionGroupOutput, error)

Removes the specified protection group.

func (*Client) DeleteSubscription deprecated 

func (c *Client) DeleteSubscription(ctx context.Context, params *DeleteSubscriptionInput, optFns ...func(*Options)) (*DeleteSubscriptionOutput, error)

Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

Deprecated: This operation has been deprecated.

func (*Client) DescribeAttack 

func (c *Client) DescribeAttack(ctx context.Context, params *DescribeAttackInput, optFns ...func(*Options)) (*DescribeAttackOutput, error)

Describes the details of a DDoS attack.

func (*Client) DescribeAttackStatistics added in v0.30.0 

func (c *Client) DescribeAttackStatistics(ctx context.Context, params *DescribeAttackStatisticsInput, optFns ...func(*Options)) (*DescribeAttackStatisticsOutput, error)

Provides information about the number and type of attacks AWS Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers. The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC. The time range indicates the period covered by the attack statistics data items.

func (*Client) DescribeDRTAccess 

func (c *Client) DescribeDRTAccess(ctx context.Context, params *DescribeDRTAccessInput, optFns ...func(*Options)) (*DescribeDRTAccessOutput, error)

Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.

func (*Client) DescribeEmergencyContactSettings 

func (c *Client) DescribeEmergencyContactSettings(ctx context.Context, params *DescribeEmergencyContactSettingsInput, optFns ...func(*Options)) (*DescribeEmergencyContactSettingsOutput, error)

A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

func (*Client) DescribeProtection 

func (c *Client) DescribeProtection(ctx context.Context, params *DescribeProtectionInput, optFns ...func(*Options)) (*DescribeProtectionOutput, error)

Lists the details of a Protection object.

func (*Client) DescribeProtectionGroup added in v0.30.0 

func (c *Client) DescribeProtectionGroup(ctx context.Context, params *DescribeProtectionGroupInput, optFns ...func(*Options)) (*DescribeProtectionGroupOutput, error)

Returns the specification for the specified protection group.

func (*Client) DescribeSubscription 

func (c *Client) DescribeSubscription(ctx context.Context, params *DescribeSubscriptionInput, optFns ...func(*Options)) (*DescribeSubscriptionOutput, error)

Provides details about the AWS Shield Advanced subscription for an account.

func (*Client) DisableProactiveEngagement 

func (c *Client) DisableProactiveEngagement(ctx context.Context, params *DisableProactiveEngagementInput, optFns ...func(*Options)) (*DisableProactiveEngagementOutput, error)

Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.

func (*Client) DisassociateDRTLogBucket 

func (c *Client) DisassociateDRTLogBucket(ctx context.Context, params *DisassociateDRTLogBucketInput, optFns ...func(*Options)) (*DisassociateDRTLogBucketOutput, error)

Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs. To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

func (*Client) DisassociateDRTRole 

func (c *Client) DisassociateDRTRole(ctx context.Context, params *DisassociateDRTRoleInput, optFns ...func(*Options)) (*DisassociateDRTRoleOutput, error)

Removes the DDoS Response Team's (DRT) access to your AWS account. To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

func (*Client) DisassociateHealthCheck 

func (c *Client) DisassociateHealthCheck(ctx context.Context, params *DisassociateHealthCheckInput, optFns ...func(*Options)) (*DisassociateHealthCheckOutput, error)

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection (https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option) in the AWS WAF and AWS Shield Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

func (*Client) EnableProactiveEngagement 

func (c *Client) EnableProactiveEngagement(ctx context.Context, params *EnableProactiveEngagementInput, optFns ...func(*Options)) (*EnableProactiveEngagementOutput, error)

Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.

func (*Client) GetSubscriptionState 

func (c *Client) GetSubscriptionState(ctx context.Context, params *GetSubscriptionStateInput, optFns ...func(*Options)) (*GetSubscriptionStateOutput, error)

Returns the SubscriptionState, either Active or Inactive.

func (*Client) ListAttacks 

func (c *Client) ListAttacks(ctx context.Context, params *ListAttacksInput, optFns ...func(*Options)) (*ListAttacksOutput, error)

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

func (*Client) ListProtectionGroups added in v0.30.0 

func (c *Client) ListProtectionGroups(ctx context.Context, params *ListProtectionGroupsInput, optFns ...func(*Options)) (*ListProtectionGroupsOutput, error)

Retrieves the ProtectionGroup objects for the account.

func (*Client) ListProtections 

func (c *Client) ListProtections(ctx context.Context, params *ListProtectionsInput, optFns ...func(*Options)) (*ListProtectionsOutput, error)

Lists all Protection objects for the account.

func (*Client) ListResourcesInProtectionGroup added in v0.30.0 

func (c *Client) ListResourcesInProtectionGroup(ctx context.Context, params *ListResourcesInProtectionGroupInput, optFns ...func(*Options)) (*ListResourcesInProtectionGroupOutput, error)

Retrieves the resources that are included in the protection group.

func (*Client) UpdateEmergencyContactSettings 

func (c *Client) UpdateEmergencyContactSettings(ctx context.Context, params *UpdateEmergencyContactSettingsInput, optFns ...func(*Options)) (*UpdateEmergencyContactSettingsOutput, error)

Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

func (*Client) UpdateProtectionGroup added in v0.30.0 

func (c *Client) UpdateProtectionGroup(ctx context.Context, params *UpdateProtectionGroupInput, optFns ...func(*Options)) (*UpdateProtectionGroupOutput, error)

Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

func (*Client) UpdateSubscription 

func (c *Client) UpdateSubscription(ctx context.Context, params *UpdateSubscriptionInput, optFns ...func(*Options)) (*UpdateSubscriptionOutput, error)

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

type CreateProtectionGroupInput added in v0.30.0 

type CreateProtectionGroupInput struct {

	// Defines how AWS Shield combines resource data for the group in order to detect,
	// mitigate, and report events.
	//
	// * Sum - Use the total traffic across the group.
	// This is a good choice for most cases. Examples include Elastic IP addresses for
	// EC2 instances that scale manually or automatically.
	//
	// * Mean - Use the average of
	// the traffic across the group. This is a good choice for resources that share
	// traffic uniformly. Examples include accelerators and load balancers.
	//
	// * Max -
	// Use the highest traffic from each resource. This is useful for resources that
	// don't share traffic and for resources that share that traffic in a non-uniform
	// way. Examples include CloudFront distributions and origin resources for
	// CloudFront distributions.
	//
	// This member is required.
	Aggregation types.ProtectionGroupAggregation

	// The criteria to use to choose the protected resources for inclusion in the
	// group. You can include all resources that have protections, provide a list of
	// resource Amazon Resource Names (ARNs), or include all resources of a specified
	// resource type.
	//
	// This member is required.
	Pattern types.ProtectionGroupPattern

	// The name of the protection group. You use this to identify the protection group
	// in lists and to manage the protection group, for example to update, delete, or
	// describe it.
	//
	// This member is required.
	ProtectionGroupId *string

	// The Amazon Resource Names (ARNs) of the resources to include in the protection
	// group. You must set this when you set Pattern to ARBITRARY and you must not set
	// it for any other Pattern setting.
	Members []string

	// The resource type to include in the protection group. All protected resources of
	// this type are included in the protection group. Newly protected resources of
	// this type are automatically added to the group. You must set this when you set
	// Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern
	// setting.
	ResourceType types.ProtectedResourceType
}

type CreateProtectionGroupOutput added in v0.30.0 

type CreateProtectionGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProtectionInput 

type CreateProtectionInput struct {

	// Friendly name for the Protection you are creating.
	//
	// This member is required.
	Name *string

	// The ARN (Amazon Resource Name) of the resource to be protected. The ARN should
	// be in one of the following formats:
	//
	// * For an Application Load Balancer:
	// arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
	//
	// *
	// For an Elastic Load Balancer (Classic Load Balancer):
	// arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
	//
	// *
	// For an AWS CloudFront distribution:
	// arn:aws:cloudfront::account-id:distribution/distribution-id
	//
	// * For an AWS Global
	// Accelerator accelerator:
	// arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
	//
	// * For Amazon
	// Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
	//
	// * For an Elastic IP
	// address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id
	//
	// This member is required.
	ResourceArn *string
}

type CreateProtectionOutput 

type CreateProtectionOutput struct {

	// The unique identifier (ID) for the Protection object that is created.
	ProtectionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSubscriptionInput 

type CreateSubscriptionInput struct {
}

type CreateSubscriptionOutput 

type CreateSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProtectionGroupInput added in v0.30.0 

type DeleteProtectionGroupInput struct {

	// The name of the protection group. You use this to identify the protection group
	// in lists and to manage the protection group, for example to update, delete, or
	// describe it.
	//
	// This member is required.
	ProtectionGroupId *string
}

type DeleteProtectionGroupOutput added in v0.30.0 

type DeleteProtectionGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProtectionInput 

type DeleteProtectionInput struct {

	// The unique identifier (ID) for the Protection object to be deleted.
	//
	// This member is required.
	ProtectionId *string
}

type DeleteProtectionOutput 

type DeleteProtectionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSubscriptionInput 

type DeleteSubscriptionInput struct {
}

type DeleteSubscriptionOutput 

type DeleteSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAttackInput 

type DescribeAttackInput struct {

	// The unique identifier (ID) for the attack that to be described.
	//
	// This member is required.
	AttackId *string
}

type DescribeAttackOutput 

type DescribeAttackOutput struct {

	// The attack that is described.
	Attack *types.AttackDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAttackStatisticsInput added in v0.30.0 

type DescribeAttackStatisticsInput struct {
}

type DescribeAttackStatisticsOutput added in v0.30.0 

type DescribeAttackStatisticsOutput struct {

	// The data that describes the attacks detected during the time period.
	//
	// This member is required.
	DataItems []types.AttackStatisticsDataItem

	// The time range.
	//
	// This member is required.
	TimeRange *types.TimeRange

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDRTAccessInput 

type DescribeDRTAccessInput struct {
}

type DescribeDRTAccessOutput 

type DescribeDRTAccessOutput struct {

	// The list of Amazon S3 buckets accessed by the DRT.
	LogBucketList []string

	// The Amazon Resource Name (ARN) of the role the DRT used to access your AWS
	// account.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeEmergencyContactSettingsInput 

type DescribeEmergencyContactSettingsInput struct {
}

type DescribeEmergencyContactSettingsOutput 

type DescribeEmergencyContactSettingsOutput struct {

	// A list of email addresses and phone numbers that the DDoS Response Team (DRT)
	// can use to contact you if you have proactive engagement enabled, for escalations
	// to the DRT and to initiate proactive customer support.
	EmergencyContactList []types.EmergencyContact

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeProtectionGroupInput added in v0.30.0 

type DescribeProtectionGroupInput struct {

	// The name of the protection group. You use this to identify the protection group
	// in lists and to manage the protection group, for example to update, delete, or
	// describe it.
	//
	// This member is required.
	ProtectionGroupId *string
}

type DescribeProtectionGroupOutput added in v0.30.0 

type DescribeProtectionGroupOutput struct {

	// A grouping of protected resources that you and AWS Shield Advanced can monitor
	// as a collective. This resource grouping improves the accuracy of detection and
	// reduces false positives.
	//
	// This member is required.
	ProtectionGroup *types.ProtectionGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeProtectionInput 

type DescribeProtectionInput struct {

	// The unique identifier (ID) for the Protection object that is described. When
	// submitting the DescribeProtection request you must provide either the
	// ResourceArn or the ProtectionID, but not both.
	ProtectionId *string

	// The ARN (Amazon Resource Name) of the AWS resource for the Protection object
	// that is described. When submitting the DescribeProtection request you must
	// provide either the ResourceArn or the ProtectionID, but not both.
	ResourceArn *string
}

type DescribeProtectionOutput 

type DescribeProtectionOutput struct {

	// The Protection object that is described.
	Protection *types.Protection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSubscriptionInput 

type DescribeSubscriptionInput struct {
}

type DescribeSubscriptionOutput 

type DescribeSubscriptionOutput struct {

	// The AWS Shield Advanced subscription details for an account.
	Subscription *types.Subscription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisableProactiveEngagementInput 

type DisableProactiveEngagementInput struct {
}

type DisableProactiveEngagementOutput 

type DisableProactiveEngagementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateDRTLogBucketInput 

type DisassociateDRTLogBucketInput struct {

	// The Amazon S3 bucket that contains your AWS WAF logs.
	//
	// This member is required.
	LogBucket *string
}

type DisassociateDRTLogBucketOutput 

type DisassociateDRTLogBucketOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateDRTRoleInput 

type DisassociateDRTRoleInput struct {
}

type DisassociateDRTRoleOutput 

type DisassociateDRTRoleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateHealthCheckInput 

type DisassociateHealthCheckInput struct {

	// The Amazon Resource Name (ARN) of the health check that is associated with the
	// protection.
	//
	// This member is required.
	HealthCheckArn *string

	// The unique identifier (ID) for the Protection object to remove the health check
	// association from.
	//
	// This member is required.
	ProtectionId *string
}

type DisassociateHealthCheckOutput 

type DisassociateHealthCheckOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EnableProactiveEngagementInput 

type EnableProactiveEngagementInput struct {
}

type EnableProactiveEngagementOutput 

type EnableProactiveEngagementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetSubscriptionStateInput 

type GetSubscriptionStateInput struct {
}

type GetSubscriptionStateOutput 

type GetSubscriptionStateOutput struct {

	// The status of the subscription.
	//
	// This member is required.
	SubscriptionState types.SubscriptionState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAttacksAPIClient added in v0.30.0 

type ListAttacksAPIClient interface {
	ListAttacks(context.Context, *ListAttacksInput, ...func(*Options)) (*ListAttacksOutput, error)
}

ListAttacksAPIClient is a client that implements the ListAttacks operation.

type ListAttacksInput 

type ListAttacksInput struct {

	// The end of the time period for the attacks. This is a timestamp type. The sample
	// request above indicates a number type because the default used by WAF is Unix
	// time in seconds. However any valid timestamp format
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types)
	// is allowed.
	EndTime *types.TimeRange

	// The maximum number of AttackSummary objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results. This is a maximum value. Shield
	// Advanced might return the results in smaller batches. That is, the number of
	// objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	MaxResults *int32

	// The ListAttacksRequest.NextMarker value from a previous call to
	// ListAttacksRequest. Pass null if this is the first call.
	NextToken *string

	// The ARN (Amazon Resource Name) of the resource that was attacked. If this is
	// left blank, all applicable resources for this account will be included.
	ResourceArns []string

	// The start of the time period for the attacks. This is a timestamp type. The
	// sample request above indicates a number type because the default used by WAF is
	// Unix time in seconds. However any valid timestamp format
	// (http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types)
	// is allowed.
	StartTime *types.TimeRange
}

type ListAttacksOutput 

type ListAttacksOutput struct {

	// The attack information for the specified time range.
	AttackSummaries []types.AttackSummary

	// The token returned by a previous call to indicate that there is more data
	// available. If not null, more results are available. Pass this value for the
	// NextMarker parameter in a subsequent call to ListAttacks to retrieve the next
	// set of items. Shield Advanced might return the list of AttackSummary objects in
	// batches smaller than the number specified by MaxResults. If there are more
	// attack summary objects to return, Shield Advanced will always also return a
	// NextToken.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAttacksPaginator added in v0.30.0 

type ListAttacksPaginator struct {
	// contains filtered or unexported fields
}

ListAttacksPaginator is a paginator for ListAttacks

func NewListAttacksPaginator added in v0.30.0 

func NewListAttacksPaginator(client ListAttacksAPIClient, params *ListAttacksInput, optFns ...func(*ListAttacksPaginatorOptions)) *ListAttacksPaginator

NewListAttacksPaginator returns a new ListAttacksPaginator

func (*ListAttacksPaginator) HasMorePages added in v0.30.0 

func (p *ListAttacksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAttacksPaginator) NextPage added in v0.30.0 

func (p *ListAttacksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAttacksOutput, error)

NextPage retrieves the next ListAttacks page.

type ListAttacksPaginatorOptions added in v0.30.0 

type ListAttacksPaginatorOptions struct {
	// The maximum number of AttackSummary objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results. This is a maximum value. Shield
	// Advanced might return the results in smaller batches. That is, the number of
	// objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAttacksPaginatorOptions is the paginator options for ListAttacks

type ListProtectionGroupsAPIClient added in v0.30.0 

type ListProtectionGroupsAPIClient interface {
	ListProtectionGroups(context.Context, *ListProtectionGroupsInput, ...func(*Options)) (*ListProtectionGroupsOutput, error)
}

ListProtectionGroupsAPIClient is a client that implements the ListProtectionGroups operation.

type ListProtectionGroupsInput added in v0.30.0 

type ListProtectionGroupsInput struct {

	// The maximum number of ProtectionGroup objects to return. If you leave this
	// blank, Shield Advanced returns the first 20 results. This is a maximum value.
	// Shield Advanced might return the results in smaller batches. That is, the number
	// of objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	MaxResults *int32

	// The next token value from a previous call to ListProtectionGroups. Pass null if
	// this is the first call.
	NextToken *string
}

type ListProtectionGroupsOutput added in v0.30.0 

type ListProtectionGroupsOutput struct {

	//
	//
	// This member is required.
	ProtectionGroups []types.ProtectionGroup

	// If you specify a value for MaxResults and you have more protection groups than
	// the value of MaxResults, AWS Shield Advanced returns this token that you can use
	// in your next request, to get the next batch of objects.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListProtectionGroupsPaginator added in v0.30.0 

type ListProtectionGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListProtectionGroupsPaginator is a paginator for ListProtectionGroups

func NewListProtectionGroupsPaginator added in v0.30.0 

func NewListProtectionGroupsPaginator(client ListProtectionGroupsAPIClient, params *ListProtectionGroupsInput, optFns ...func(*ListProtectionGroupsPaginatorOptions)) *ListProtectionGroupsPaginator

NewListProtectionGroupsPaginator returns a new ListProtectionGroupsPaginator

func (*ListProtectionGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListProtectionGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProtectionGroupsPaginator) NextPage added in v0.30.0 

func (p *ListProtectionGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProtectionGroupsOutput, error)

NextPage retrieves the next ListProtectionGroups page.

type ListProtectionGroupsPaginatorOptions added in v0.30.0 

type ListProtectionGroupsPaginatorOptions struct {
	// The maximum number of ProtectionGroup objects to return. If you leave this
	// blank, Shield Advanced returns the first 20 results. This is a maximum value.
	// Shield Advanced might return the results in smaller batches. That is, the number
	// of objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProtectionGroupsPaginatorOptions is the paginator options for ListProtectionGroups

type ListProtectionsAPIClient added in v0.30.0 

type ListProtectionsAPIClient interface {
	ListProtections(context.Context, *ListProtectionsInput, ...func(*Options)) (*ListProtectionsOutput, error)
}

ListProtectionsAPIClient is a client that implements the ListProtections operation.

type ListProtectionsInput 

type ListProtectionsInput struct {

	// The maximum number of Protection objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results. This is a maximum value. Shield
	// Advanced might return the results in smaller batches. That is, the number of
	// objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	MaxResults *int32

	// The ListProtectionsRequest.NextToken value from a previous call to
	// ListProtections. Pass null if this is the first call.
	NextToken *string
}

type ListProtectionsOutput 

type ListProtectionsOutput struct {

	// If you specify a value for MaxResults and you have more Protections than the
	// value of MaxResults, AWS Shield Advanced returns a NextToken value in the
	// response that allows you to list another group of Protections. For the second
	// and subsequent ListProtections requests, specify the value of NextToken from the
	// previous response to get information about another batch of Protections. Shield
	// Advanced might return the list of Protection objects in batches smaller than the
	// number specified by MaxResults. If there are more Protection objects to return,
	// Shield Advanced will always also return a NextToken.
	NextToken *string

	// The array of enabled Protection objects.
	Protections []types.Protection

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListProtectionsPaginator added in v0.30.0 

type ListProtectionsPaginator struct {
	// contains filtered or unexported fields
}

ListProtectionsPaginator is a paginator for ListProtections

func NewListProtectionsPaginator added in v0.30.0 

func NewListProtectionsPaginator(client ListProtectionsAPIClient, params *ListProtectionsInput, optFns ...func(*ListProtectionsPaginatorOptions)) *ListProtectionsPaginator

NewListProtectionsPaginator returns a new ListProtectionsPaginator

func (*ListProtectionsPaginator) HasMorePages added in v0.30.0 

func (p *ListProtectionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProtectionsPaginator) NextPage added in v0.30.0 

func (p *ListProtectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProtectionsOutput, error)

NextPage retrieves the next ListProtections page.

type ListProtectionsPaginatorOptions added in v0.30.0 

type ListProtectionsPaginatorOptions struct {
	// The maximum number of Protection objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results. This is a maximum value. Shield
	// Advanced might return the results in smaller batches. That is, the number of
	// objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProtectionsPaginatorOptions is the paginator options for ListProtections

type ListResourcesInProtectionGroupAPIClient added in v0.30.0 

type ListResourcesInProtectionGroupAPIClient interface {
	ListResourcesInProtectionGroup(context.Context, *ListResourcesInProtectionGroupInput, ...func(*Options)) (*ListResourcesInProtectionGroupOutput, error)
}

ListResourcesInProtectionGroupAPIClient is a client that implements the ListResourcesInProtectionGroup operation.

type ListResourcesInProtectionGroupInput added in v0.30.0 

type ListResourcesInProtectionGroupInput struct {

	// The name of the protection group. You use this to identify the protection group
	// in lists and to manage the protection group, for example to update, delete, or
	// describe it.
	//
	// This member is required.
	ProtectionGroupId *string

	// The maximum number of resource ARN objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results. This is a maximum value. Shield
	// Advanced might return the results in smaller batches. That is, the number of
	// objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	MaxResults *int32

	// The next token value from a previous call to ListResourcesInProtectionGroup.
	// Pass null if this is the first call.
	NextToken *string
}

type ListResourcesInProtectionGroupOutput added in v0.30.0 

type ListResourcesInProtectionGroupOutput struct {

	// The Amazon Resource Names (ARNs) of the resources that are included in the
	// protection group.
	//
	// This member is required.
	ResourceArns []string

	// If you specify a value for MaxResults and you have more resources in the
	// protection group than the value of MaxResults, AWS Shield Advanced returns this
	// token that you can use in your next request, to get the next batch of objects.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourcesInProtectionGroupPaginator added in v0.30.0 

type ListResourcesInProtectionGroupPaginator struct {
	// contains filtered or unexported fields
}

ListResourcesInProtectionGroupPaginator is a paginator for ListResourcesInProtectionGroup

func NewListResourcesInProtectionGroupPaginator added in v0.30.0 

func NewListResourcesInProtectionGroupPaginator(client ListResourcesInProtectionGroupAPIClient, params *ListResourcesInProtectionGroupInput, optFns ...func(*ListResourcesInProtectionGroupPaginatorOptions)) *ListResourcesInProtectionGroupPaginator

NewListResourcesInProtectionGroupPaginator returns a new ListResourcesInProtectionGroupPaginator

func (*ListResourcesInProtectionGroupPaginator) HasMorePages added in v0.30.0 

func (p *ListResourcesInProtectionGroupPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourcesInProtectionGroupPaginator) NextPage added in v0.30.0 

func (p *ListResourcesInProtectionGroupPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesInProtectionGroupOutput, error)

NextPage retrieves the next ListResourcesInProtectionGroup page.

type ListResourcesInProtectionGroupPaginatorOptions added in v0.30.0 

type ListResourcesInProtectionGroupPaginatorOptions struct {
	// The maximum number of resource ARN objects to return. If you leave this blank,
	// Shield Advanced returns the first 20 results. This is a maximum value. Shield
	// Advanced might return the results in smaller batches. That is, the number of
	// objects returned could be less than MaxResults, even if there are still more
	// objects yet to return. If there are more objects to return, Shield Advanced
	// returns a value in NextToken that you can use in your next request, to get the
	// next batch of objects.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourcesInProtectionGroupPaginatorOptions is the paginator options for ListResourcesInProtectionGroup

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type UpdateEmergencyContactSettingsInput 

type UpdateEmergencyContactSettingsInput struct {

	// A list of email addresses and phone numbers that the DDoS Response Team (DRT)
	// can use to contact you if you have proactive engagement enabled, for escalations
	// to the DRT and to initiate proactive customer support. If you have proactive
	// engagement enabled, the contact list must include at least one phone number.
	EmergencyContactList []types.EmergencyContact
}

type UpdateEmergencyContactSettingsOutput 

type UpdateEmergencyContactSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateProtectionGroupInput added in v0.30.0 

type UpdateProtectionGroupInput struct {

	// Defines how AWS Shield combines resource data for the group in order to detect,
	// mitigate, and report events.
	//
	// * Sum - Use the total traffic across the group.
	// This is a good choice for most cases. Examples include Elastic IP addresses for
	// EC2 instances that scale manually or automatically.
	//
	// * Mean - Use the average of
	// the traffic across the group. This is a good choice for resources that share
	// traffic uniformly. Examples include accelerators and load balancers.
	//
	// * Max -
	// Use the highest traffic from each resource. This is useful for resources that
	// don't share traffic and for resources that share that traffic in a non-uniform
	// way. Examples include CloudFront distributions and origin resources for
	// CloudFront distributions.
	//
	// This member is required.
	Aggregation types.ProtectionGroupAggregation

	// The criteria to use to choose the protected resources for inclusion in the
	// group. You can include all resources that have protections, provide a list of
	// resource Amazon Resource Names (ARNs), or include all resources of a specified
	// resource type.
	//
	// This member is required.
	Pattern types.ProtectionGroupPattern

	// The name of the protection group. You use this to identify the protection group
	// in lists and to manage the protection group, for example to update, delete, or
	// describe it.
	//
	// This member is required.
	ProtectionGroupId *string

	// The Amazon Resource Names (ARNs) of the resources to include in the protection
	// group. You must set this when you set Pattern to ARBITRARY and you must not set
	// it for any other Pattern setting.
	Members []string

	// The resource type to include in the protection group. All protected resources of
	// this type are included in the protection group. You must set this when you set
	// Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern
	// setting.
	ResourceType types.ProtectedResourceType
}

type UpdateProtectionGroupOutput added in v0.30.0 

type UpdateProtectionGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateSubscriptionInput 

type UpdateSubscriptionInput struct {

	// 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.
	AutoRenew types.AutoRenew
}

type UpdateSubscriptionOutput 

type UpdateSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.