fms

package
v1.32.11 Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2020 License: Apache-2.0 Imports: 10 Imported by: 58

Documentation

Overview

Package fms provides the client and types for making API requests to Firewall Management Service.

This is the AWS Firewall Manager API Reference. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS Firewall Manager Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html).

See https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01 for more information on this service.

See fms package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/fms/

Using the Client

To contact Firewall Management Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Firewall Management Service client FMS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/fms/#New

Index

Constants

View Source 
const (
	// AccountRoleStatusReady is a AccountRoleStatus enum value
	AccountRoleStatusReady = "READY"

	// AccountRoleStatusCreating is a AccountRoleStatus enum value
	AccountRoleStatusCreating = "CREATING"

	// AccountRoleStatusPendingDeletion is a AccountRoleStatus enum value
	AccountRoleStatusPendingDeletion = "PENDING_DELETION"

	// AccountRoleStatusDeleting is a AccountRoleStatus enum value
	AccountRoleStatusDeleting = "DELETING"

	// AccountRoleStatusDeleted is a AccountRoleStatus enum value
	AccountRoleStatusDeleted = "DELETED"
)
View Source 
const (
	// CustomerPolicyScopeIdTypeAccount is a CustomerPolicyScopeIdType enum value
	CustomerPolicyScopeIdTypeAccount = "ACCOUNT"

	// CustomerPolicyScopeIdTypeOrgUnit is a CustomerPolicyScopeIdType enum value
	CustomerPolicyScopeIdTypeOrgUnit = "ORG_UNIT"
)
View Source 
const (
	// DependentServiceNameAwsconfig is a DependentServiceName enum value
	DependentServiceNameAwsconfig = "AWSCONFIG"

	// DependentServiceNameAwswaf is a DependentServiceName enum value
	DependentServiceNameAwswaf = "AWSWAF"

	// DependentServiceNameAwsshieldAdvanced is a DependentServiceName enum value
	DependentServiceNameAwsshieldAdvanced = "AWSSHIELD_ADVANCED"

	// DependentServiceNameAwsvpc is a DependentServiceName enum value
	DependentServiceNameAwsvpc = "AWSVPC"
)
View Source 
const (
	// PolicyComplianceStatusTypeCompliant is a PolicyComplianceStatusType enum value
	PolicyComplianceStatusTypeCompliant = "COMPLIANT"

	// PolicyComplianceStatusTypeNonCompliant is a PolicyComplianceStatusType enum value
	PolicyComplianceStatusTypeNonCompliant = "NON_COMPLIANT"
)
View Source 
const (
	// SecurityServiceTypeWaf is a SecurityServiceType enum value
	SecurityServiceTypeWaf = "WAF"

	// SecurityServiceTypeWafv2 is a SecurityServiceType enum value
	SecurityServiceTypeWafv2 = "WAFV2"

	// SecurityServiceTypeShieldAdvanced is a SecurityServiceType enum value
	SecurityServiceTypeShieldAdvanced = "SHIELD_ADVANCED"

	// SecurityServiceTypeSecurityGroupsCommon is a SecurityServiceType enum value
	SecurityServiceTypeSecurityGroupsCommon = "SECURITY_GROUPS_COMMON"

	// SecurityServiceTypeSecurityGroupsContentAudit is a SecurityServiceType enum value
	SecurityServiceTypeSecurityGroupsContentAudit = "SECURITY_GROUPS_CONTENT_AUDIT"

	// SecurityServiceTypeSecurityGroupsUsageAudit is a SecurityServiceType enum value
	SecurityServiceTypeSecurityGroupsUsageAudit = "SECURITY_GROUPS_USAGE_AUDIT"
)
View Source 
const (
	// ViolationReasonWebAclMissingRuleGroup is a ViolationReason enum value
	ViolationReasonWebAclMissingRuleGroup = "WEB_ACL_MISSING_RULE_GROUP"

	// ViolationReasonResourceMissingWebAcl is a ViolationReason enum value
	ViolationReasonResourceMissingWebAcl = "RESOURCE_MISSING_WEB_ACL"

	// ViolationReasonResourceIncorrectWebAcl is a ViolationReason enum value
	ViolationReasonResourceIncorrectWebAcl = "RESOURCE_INCORRECT_WEB_ACL"

	// ViolationReasonResourceMissingShieldProtection is a ViolationReason enum value
	ViolationReasonResourceMissingShieldProtection = "RESOURCE_MISSING_SHIELD_PROTECTION"

	// ViolationReasonResourceMissingWebAclOrShieldProtection is a ViolationReason enum value
	ViolationReasonResourceMissingWebAclOrShieldProtection = "RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION"

	// ViolationReasonResourceMissingSecurityGroup is a ViolationReason enum value
	ViolationReasonResourceMissingSecurityGroup = "RESOURCE_MISSING_SECURITY_GROUP"

	// ViolationReasonResourceViolatesAuditSecurityGroup is a ViolationReason enum value
	ViolationReasonResourceViolatesAuditSecurityGroup = "RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP"

	// ViolationReasonSecurityGroupUnused is a ViolationReason enum value
	ViolationReasonSecurityGroupUnused = "SECURITY_GROUP_UNUSED"

	// ViolationReasonSecurityGroupRedundant is a ViolationReason enum value
	ViolationReasonSecurityGroupRedundant = "SECURITY_GROUP_REDUNDANT"
)
View Source 
const (

	// ErrCodeInternalErrorException for service response error code
	// "InternalErrorException".
	//
	// The operation failed because of a system problem, even though the request
	// was valid. Retry your request.
	ErrCodeInternalErrorException = "InternalErrorException"

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// The parameters of the request were invalid.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeInvalidOperationException for service response error code
	// "InvalidOperationException".
	//
	// The operation failed because there was nothing to do. For example, you might
	// have submitted an AssociateAdminAccount request, but the account ID that
	// you submitted was already set as the AWS Firewall Manager administrator.
	ErrCodeInvalidOperationException = "InvalidOperationException"

	// ErrCodeInvalidTypeException for service response error code
	// "InvalidTypeException".
	//
	// The value of the Type parameter is invalid.
	ErrCodeInvalidTypeException = "InvalidTypeException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The operation exceeds a resource limit, for example, the maximum number of
	// policy objects that you can create for an AWS account. For more information,
	// see Firewall Manager Limits (https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html)
	// in the AWS WAF Developer Guide.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "fms"       // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "FMS"       // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AssociateAdminAccountInput 

type AssociateAdminAccountInput struct {

	// The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall
	// Manager administrator account. This can be an AWS Organizations master account
	// or a member account. For more information about AWS Organizations and master
	// accounts, see Managing the AWS Accounts in Your Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html).
	//
	// AdminAccount is a required field
	AdminAccount *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateAdminAccountInput) GoString 

func (s AssociateAdminAccountInput) GoString() string

GoString returns the string representation

func (*AssociateAdminAccountInput) SetAdminAccount 

func (s *AssociateAdminAccountInput) SetAdminAccount(v string) *AssociateAdminAccountInput

SetAdminAccount sets the AdminAccount field's value.

func (AssociateAdminAccountInput) String 

func (s AssociateAdminAccountInput) String() string

String returns the string representation

func (*AssociateAdminAccountInput) Validate 

func (s *AssociateAdminAccountInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateAdminAccountOutput 

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

func (AssociateAdminAccountOutput) GoString 

func (s AssociateAdminAccountOutput) GoString() string

GoString returns the string representation

func (AssociateAdminAccountOutput) String 

func (s AssociateAdminAccountOutput) String() string

String returns the string representation

type ComplianceViolator 

type ComplianceViolator struct {

	// The resource ID.
	ResourceId *string `min:"1" type:"string"`

	// The resource type. This is in the format shown in the AWS Resource Types
	// Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).
	// For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
	ResourceType *string `min:"1" type:"string"`

	// The reason that the resource is not protected by the policy.
	ViolationReason *string `type:"string" enum:"ViolationReason"`
	// contains filtered or unexported fields
}

Details of the resource that is not protected by the policy.

func (ComplianceViolator) GoString 

func (s ComplianceViolator) GoString() string

GoString returns the string representation

func (*ComplianceViolator) SetResourceId 

func (s *ComplianceViolator) SetResourceId(v string) *ComplianceViolator

SetResourceId sets the ResourceId field's value.

func (*ComplianceViolator) SetResourceType 

func (s *ComplianceViolator) SetResourceType(v string) *ComplianceViolator

SetResourceType sets the ResourceType field's value.

func (*ComplianceViolator) SetViolationReason 

func (s *ComplianceViolator) SetViolationReason(v string) *ComplianceViolator

SetViolationReason sets the ViolationReason field's value.

func (ComplianceViolator) String 

func (s ComplianceViolator) String() string

String returns the string representation

type DeleteNotificationChannelInput 

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

func (DeleteNotificationChannelInput) GoString 

func (s DeleteNotificationChannelInput) GoString() string

GoString returns the string representation

func (DeleteNotificationChannelInput) String 

func (s DeleteNotificationChannelInput) String() string

String returns the string representation

type DeleteNotificationChannelOutput 

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

func (DeleteNotificationChannelOutput) GoString 

func (s DeleteNotificationChannelOutput) GoString() string

GoString returns the string representation

func (DeleteNotificationChannelOutput) String 

func (s DeleteNotificationChannelOutput) String() string

String returns the string representation

type DeletePolicyInput 

type DeletePolicyInput struct {

	// If True, the request performs cleanup according to the policy type.
	//
	// For AWS WAF and Shield Advanced policies, the cleanup does the following:
	//
	//    * Deletes rule groups created by AWS Firewall Manager
	//
	//    * Removes web ACLs from in-scope resources
	//
	//    * Deletes web ACLs that contain no rules or rule groups
	//
	// For security group policies, the cleanup does the following for each security
	// group in the policy:
	//
	//    * Disassociates the security group from in-scope resources
	//
	//    * Deletes the security group if it was created through Firewall Manager
	//    and if it's no longer associated with any resources through another policy
	//
	// After the cleanup, in-scope resources are no longer protected by web ACLs
	// in this policy. Protection of out-of-scope resources remains unchanged. Scope
	// is determined by tags that you create and accounts that you associate with
	// the policy. When creating the policy, if you specify that only resources
	// in specific accounts or with specific tags are in scope of the policy, those
	// accounts and resources are handled by the policy. All others are out of scope.
	// If you don't specify tags or accounts, all resources are in scope.
	DeleteAllPolicyResources *bool `type:"boolean"`

	// The ID of the policy that you want to delete. PolicyId is returned by PutPolicy
	// and by ListPolicies.
	//
	// PolicyId is a required field
	PolicyId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePolicyInput) GoString 

func (s DeletePolicyInput) GoString() string

GoString returns the string representation

func (*DeletePolicyInput) SetDeleteAllPolicyResources added in v1.16.23 

func (s *DeletePolicyInput) SetDeleteAllPolicyResources(v bool) *DeletePolicyInput

SetDeleteAllPolicyResources sets the DeleteAllPolicyResources field's value.

func (*DeletePolicyInput) SetPolicyId 

func (s *DeletePolicyInput) SetPolicyId(v string) *DeletePolicyInput

SetPolicyId sets the PolicyId field's value.

func (DeletePolicyInput) String 

func (s DeletePolicyInput) String() string

String returns the string representation

func (*DeletePolicyInput) Validate 

func (s *DeletePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePolicyOutput 

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

func (DeletePolicyOutput) GoString 

func (s DeletePolicyOutput) GoString() string

GoString returns the string representation

func (DeletePolicyOutput) String 

func (s DeletePolicyOutput) String() string

String returns the string representation

type DisassociateAdminAccountInput 

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

func (DisassociateAdminAccountInput) GoString 

func (s DisassociateAdminAccountInput) GoString() string

GoString returns the string representation

func (DisassociateAdminAccountInput) String 

func (s DisassociateAdminAccountInput) String() string

String returns the string representation

type DisassociateAdminAccountOutput 

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

func (DisassociateAdminAccountOutput) GoString 

func (s DisassociateAdminAccountOutput) GoString() string

GoString returns the string representation

func (DisassociateAdminAccountOutput) String 

func (s DisassociateAdminAccountOutput) String() string

String returns the string representation

type EvaluationResult 

type EvaluationResult struct {

	// Describes an AWS account's compliance with the AWS Firewall Manager policy.
	ComplianceStatus *string `type:"string" enum:"PolicyComplianceStatusType"`

	// Indicates that over 100 resources are noncompliant with the AWS Firewall
	// Manager policy.
	EvaluationLimitExceeded *bool `type:"boolean"`

	// The number of resources that are noncompliant with the specified policy.
	// For AWS WAF and Shield Advanced policies, a resource is considered noncompliant
	// if it is not associated with the policy. For security group policies, a resource
	// is considered noncompliant if it doesn't comply with the rules of the policy
	// and remediation is disabled or not possible.
	ViolatorCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don't comply with the policy.

func (EvaluationResult) GoString 

func (s EvaluationResult) GoString() string

GoString returns the string representation

func (*EvaluationResult) SetComplianceStatus 

func (s *EvaluationResult) SetComplianceStatus(v string) *EvaluationResult

SetComplianceStatus sets the ComplianceStatus field's value.

func (*EvaluationResult) SetEvaluationLimitExceeded 

func (s *EvaluationResult) SetEvaluationLimitExceeded(v bool) *EvaluationResult

SetEvaluationLimitExceeded sets the EvaluationLimitExceeded field's value.

func (*EvaluationResult) SetViolatorCount 

func (s *EvaluationResult) SetViolatorCount(v int64) *EvaluationResult

SetViolatorCount sets the ViolatorCount field's value.

func (EvaluationResult) String 

func (s EvaluationResult) String() string

String returns the string representation

type FMS 

type FMS struct {
	*client.Client
}

FMS provides the API operation methods for making requests to Firewall Management Service. See this package's package overview docs for details on the service.

FMS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *FMS

New creates a new instance of the FMS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a FMS client from just a session.
svc := fms.New(mySession)

// Create a FMS client with additional configuration
svc := fms.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*FMS) AssociateAdminAccount 

func (c *FMS) AssociateAdminAccount(input *AssociateAdminAccountInput) (*AssociateAdminAccountOutput, error)

AssociateAdminAccount API operation for Firewall Management Service.

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account of your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.

The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation AssociateAdminAccount for usage and error information.

Returned Error Types:

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InvalidInputException The parameters of the request were invalid.

  • ResourceNotFoundException The specified resource was not found.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccount

func (*FMS) AssociateAdminAccountRequest 

func (c *FMS) AssociateAdminAccountRequest(input *AssociateAdminAccountInput) (req *request.Request, output *AssociateAdminAccountOutput)

AssociateAdminAccountRequest generates a "aws/request.Request" representing the client's request for the AssociateAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateAdminAccount for more information on using the AssociateAdminAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateAdminAccountRequest method.
req, resp := client.AssociateAdminAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccount

func (*FMS) AssociateAdminAccountWithContext 

func (c *FMS) AssociateAdminAccountWithContext(ctx aws.Context, input *AssociateAdminAccountInput, opts ...request.Option) (*AssociateAdminAccountOutput, error)

AssociateAdminAccountWithContext is the same as AssociateAdminAccount with the addition of the ability to pass a context and additional request options.

See AssociateAdminAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) DeleteNotificationChannel 

func (c *FMS) DeleteNotificationChannel(input *DeleteNotificationChannelInput) (*DeleteNotificationChannelOutput, error)

DeleteNotificationChannel API operation for Firewall Management Service.

Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation DeleteNotificationChannel for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannel

func (*FMS) DeleteNotificationChannelRequest 

func (c *FMS) DeleteNotificationChannelRequest(input *DeleteNotificationChannelInput) (req *request.Request, output *DeleteNotificationChannelOutput)

DeleteNotificationChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteNotificationChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNotificationChannel for more information on using the DeleteNotificationChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteNotificationChannelRequest method.
req, resp := client.DeleteNotificationChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannel

func (*FMS) DeleteNotificationChannelWithContext 

func (c *FMS) DeleteNotificationChannelWithContext(ctx aws.Context, input *DeleteNotificationChannelInput, opts ...request.Option) (*DeleteNotificationChannelOutput, error)

DeleteNotificationChannelWithContext is the same as DeleteNotificationChannel with the addition of the ability to pass a context and additional request options.

See DeleteNotificationChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) DeletePolicy 

func (c *FMS) DeletePolicy(input *DeletePolicyInput) (*DeletePolicyOutput, error)

DeletePolicy API operation for Firewall Management Service.

Permanently deletes an AWS Firewall Manager policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation DeletePolicy for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicy

func (*FMS) DeletePolicyRequest 

func (c *FMS) DeletePolicyRequest(input *DeletePolicyInput) (req *request.Request, output *DeletePolicyOutput)

DeletePolicyRequest generates a "aws/request.Request" representing the client's request for the DeletePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePolicy for more information on using the DeletePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePolicyRequest method.
req, resp := client.DeletePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicy

func (*FMS) DeletePolicyWithContext 

func (c *FMS) DeletePolicyWithContext(ctx aws.Context, input *DeletePolicyInput, opts ...request.Option) (*DeletePolicyOutput, error)

DeletePolicyWithContext is the same as DeletePolicy with the addition of the ability to pass a context and additional request options.

See DeletePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) DisassociateAdminAccount 

func (c *FMS) DisassociateAdminAccount(input *DisassociateAdminAccountInput) (*DisassociateAdminAccountOutput, error)

DisassociateAdminAccount API operation for Firewall Management Service.

Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation DisassociateAdminAccount for usage and error information.

Returned Error Types:

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • ResourceNotFoundException The specified resource was not found.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccount

func (*FMS) DisassociateAdminAccountRequest 

func (c *FMS) DisassociateAdminAccountRequest(input *DisassociateAdminAccountInput) (req *request.Request, output *DisassociateAdminAccountOutput)

DisassociateAdminAccountRequest generates a "aws/request.Request" representing the client's request for the DisassociateAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateAdminAccount for more information on using the DisassociateAdminAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateAdminAccountRequest method.
req, resp := client.DisassociateAdminAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccount

func (*FMS) DisassociateAdminAccountWithContext 

func (c *FMS) DisassociateAdminAccountWithContext(ctx aws.Context, input *DisassociateAdminAccountInput, opts ...request.Option) (*DisassociateAdminAccountOutput, error)

DisassociateAdminAccountWithContext is the same as DisassociateAdminAccount with the addition of the ability to pass a context and additional request options.

See DisassociateAdminAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) GetAdminAccount 

func (c *FMS) GetAdminAccount(input *GetAdminAccountInput) (*GetAdminAccountOutput, error)

GetAdminAccount API operation for Firewall Management Service.

Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation GetAdminAccount for usage and error information.

Returned Error Types:

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • ResourceNotFoundException The specified resource was not found.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccount

func (*FMS) GetAdminAccountRequest 

func (c *FMS) GetAdminAccountRequest(input *GetAdminAccountInput) (req *request.Request, output *GetAdminAccountOutput)

GetAdminAccountRequest generates a "aws/request.Request" representing the client's request for the GetAdminAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAdminAccount for more information on using the GetAdminAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAdminAccountRequest method.
req, resp := client.GetAdminAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccount

func (*FMS) GetAdminAccountWithContext 

func (c *FMS) GetAdminAccountWithContext(ctx aws.Context, input *GetAdminAccountInput, opts ...request.Option) (*GetAdminAccountOutput, error)

GetAdminAccountWithContext is the same as GetAdminAccount with the addition of the ability to pass a context and additional request options.

See GetAdminAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) GetComplianceDetail 

func (c *FMS) GetComplianceDetail(input *GetComplianceDetailInput) (*GetComplianceDetailOutput, error)

GetComplianceDetail API operation for Firewall Management Service.

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for AWS WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation GetComplianceDetail for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetail

func (*FMS) GetComplianceDetailRequest 

func (c *FMS) GetComplianceDetailRequest(input *GetComplianceDetailInput) (req *request.Request, output *GetComplianceDetailOutput)

GetComplianceDetailRequest generates a "aws/request.Request" representing the client's request for the GetComplianceDetail operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetComplianceDetail for more information on using the GetComplianceDetail API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetComplianceDetailRequest method.
req, resp := client.GetComplianceDetailRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetail

func (*FMS) GetComplianceDetailWithContext 

func (c *FMS) GetComplianceDetailWithContext(ctx aws.Context, input *GetComplianceDetailInput, opts ...request.Option) (*GetComplianceDetailOutput, error)

GetComplianceDetailWithContext is the same as GetComplianceDetail with the addition of the ability to pass a context and additional request options.

See GetComplianceDetail for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) GetNotificationChannel 

func (c *FMS) GetNotificationChannel(input *GetNotificationChannelInput) (*GetNotificationChannelOutput, error)

GetNotificationChannel API operation for Firewall Management Service.

Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation GetNotificationChannel for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannel

func (*FMS) GetNotificationChannelRequest 

func (c *FMS) GetNotificationChannelRequest(input *GetNotificationChannelInput) (req *request.Request, output *GetNotificationChannelOutput)

GetNotificationChannelRequest generates a "aws/request.Request" representing the client's request for the GetNotificationChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetNotificationChannel for more information on using the GetNotificationChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetNotificationChannelRequest method.
req, resp := client.GetNotificationChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannel

func (*FMS) GetNotificationChannelWithContext 

func (c *FMS) GetNotificationChannelWithContext(ctx aws.Context, input *GetNotificationChannelInput, opts ...request.Option) (*GetNotificationChannelOutput, error)

GetNotificationChannelWithContext is the same as GetNotificationChannel with the addition of the ability to pass a context and additional request options.

See GetNotificationChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) GetPolicy 

func (c *FMS) GetPolicy(input *GetPolicyInput) (*GetPolicyOutput, error)

GetPolicy API operation for Firewall Management Service.

Returns information about the specified AWS Firewall Manager policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation GetPolicy for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

  • InvalidTypeException The value of the Type parameter is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicy

func (*FMS) GetPolicyRequest 

func (c *FMS) GetPolicyRequest(input *GetPolicyInput) (req *request.Request, output *GetPolicyOutput)

GetPolicyRequest generates a "aws/request.Request" representing the client's request for the GetPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPolicy for more information on using the GetPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetPolicyRequest method.
req, resp := client.GetPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicy

func (*FMS) GetPolicyWithContext 

func (c *FMS) GetPolicyWithContext(ctx aws.Context, input *GetPolicyInput, opts ...request.Option) (*GetPolicyOutput, error)

GetPolicyWithContext is the same as GetPolicy with the addition of the ability to pass a context and additional request options.

See GetPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) GetProtectionStatus added in v1.19.4 

func (c *FMS) GetProtectionStatus(input *GetProtectionStatusInput) (*GetProtectionStatusOutput, error)

GetProtectionStatus API operation for Firewall Management Service.

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation GetProtectionStatus for usage and error information.

Returned Error Types:

  • InvalidInputException The parameters of the request were invalid.

  • ResourceNotFoundException The specified resource was not found.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetProtectionStatus

func (*FMS) GetProtectionStatusRequest added in v1.19.4 

func (c *FMS) GetProtectionStatusRequest(input *GetProtectionStatusInput) (req *request.Request, output *GetProtectionStatusOutput)

GetProtectionStatusRequest generates a "aws/request.Request" representing the client's request for the GetProtectionStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetProtectionStatus for more information on using the GetProtectionStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetProtectionStatusRequest method.
req, resp := client.GetProtectionStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetProtectionStatus

func (*FMS) GetProtectionStatusWithContext added in v1.19.4 

func (c *FMS) GetProtectionStatusWithContext(ctx aws.Context, input *GetProtectionStatusInput, opts ...request.Option) (*GetProtectionStatusOutput, error)

GetProtectionStatusWithContext is the same as GetProtectionStatus with the addition of the ability to pass a context and additional request options.

See GetProtectionStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) ListComplianceStatus 

func (c *FMS) ListComplianceStatus(input *ListComplianceStatusInput) (*ListComplianceStatusOutput, error)

ListComplianceStatus API operation for Firewall Management Service.

Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation ListComplianceStatus for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatus

func (*FMS) ListComplianceStatusPages added in v1.19.4 

func (c *FMS) ListComplianceStatusPages(input *ListComplianceStatusInput, fn func(*ListComplianceStatusOutput, bool) bool) error

ListComplianceStatusPages iterates over the pages of a ListComplianceStatus operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListComplianceStatus method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListComplianceStatus operation.
pageNum := 0
err := client.ListComplianceStatusPages(params,
    func(page *fms.ListComplianceStatusOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FMS) ListComplianceStatusPagesWithContext added in v1.19.4 

func (c *FMS) ListComplianceStatusPagesWithContext(ctx aws.Context, input *ListComplianceStatusInput, fn func(*ListComplianceStatusOutput, bool) bool, opts ...request.Option) error

ListComplianceStatusPagesWithContext same as ListComplianceStatusPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) ListComplianceStatusRequest 

func (c *FMS) ListComplianceStatusRequest(input *ListComplianceStatusInput) (req *request.Request, output *ListComplianceStatusOutput)

ListComplianceStatusRequest generates a "aws/request.Request" representing the client's request for the ListComplianceStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListComplianceStatus for more information on using the ListComplianceStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListComplianceStatusRequest method.
req, resp := client.ListComplianceStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatus

func (*FMS) ListComplianceStatusWithContext 

func (c *FMS) ListComplianceStatusWithContext(ctx aws.Context, input *ListComplianceStatusInput, opts ...request.Option) (*ListComplianceStatusOutput, error)

ListComplianceStatusWithContext is the same as ListComplianceStatus with the addition of the ability to pass a context and additional request options.

See ListComplianceStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) ListMemberAccounts added in v1.15.34 

func (c *FMS) ListMemberAccounts(input *ListMemberAccountsInput) (*ListMemberAccountsOutput, error)

ListMemberAccounts API operation for Firewall Management Service.

Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.

The ListMemberAccounts must be submitted by the account that is set as the AWS Firewall Manager administrator.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation ListMemberAccounts for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListMemberAccounts

func (*FMS) ListMemberAccountsPages added in v1.19.4 

func (c *FMS) ListMemberAccountsPages(input *ListMemberAccountsInput, fn func(*ListMemberAccountsOutput, bool) bool) error

ListMemberAccountsPages iterates over the pages of a ListMemberAccounts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMemberAccounts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListMemberAccounts operation.
pageNum := 0
err := client.ListMemberAccountsPages(params,
    func(page *fms.ListMemberAccountsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FMS) ListMemberAccountsPagesWithContext added in v1.19.4 

func (c *FMS) ListMemberAccountsPagesWithContext(ctx aws.Context, input *ListMemberAccountsInput, fn func(*ListMemberAccountsOutput, bool) bool, opts ...request.Option) error

ListMemberAccountsPagesWithContext same as ListMemberAccountsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) ListMemberAccountsRequest added in v1.15.34 

func (c *FMS) ListMemberAccountsRequest(input *ListMemberAccountsInput) (req *request.Request, output *ListMemberAccountsOutput)

ListMemberAccountsRequest generates a "aws/request.Request" representing the client's request for the ListMemberAccounts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMemberAccounts for more information on using the ListMemberAccounts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMemberAccountsRequest method.
req, resp := client.ListMemberAccountsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListMemberAccounts

func (*FMS) ListMemberAccountsWithContext added in v1.15.34 

func (c *FMS) ListMemberAccountsWithContext(ctx aws.Context, input *ListMemberAccountsInput, opts ...request.Option) (*ListMemberAccountsOutput, error)

ListMemberAccountsWithContext is the same as ListMemberAccounts with the addition of the ability to pass a context and additional request options.

See ListMemberAccounts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) ListPolicies 

func (c *FMS) ListPolicies(input *ListPoliciesInput) (*ListPoliciesOutput, error)

ListPolicies API operation for Firewall Management Service.

Returns an array of PolicySummary objects in the response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation ListPolicies for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • LimitExceededException The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits (https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) in the AWS WAF Developer Guide.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPolicies

func (*FMS) ListPoliciesPages added in v1.19.4 

func (c *FMS) ListPoliciesPages(input *ListPoliciesInput, fn func(*ListPoliciesOutput, bool) bool) error

ListPoliciesPages iterates over the pages of a ListPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPolicies operation.
pageNum := 0
err := client.ListPoliciesPages(params,
    func(page *fms.ListPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FMS) ListPoliciesPagesWithContext added in v1.19.4 

func (c *FMS) ListPoliciesPagesWithContext(ctx aws.Context, input *ListPoliciesInput, fn func(*ListPoliciesOutput, bool) bool, opts ...request.Option) error

ListPoliciesPagesWithContext same as ListPoliciesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) ListPoliciesRequest 

func (c *FMS) ListPoliciesRequest(input *ListPoliciesInput) (req *request.Request, output *ListPoliciesOutput)

ListPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPolicies for more information on using the ListPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPoliciesRequest method.
req, resp := client.ListPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPolicies

func (*FMS) ListPoliciesWithContext 

func (c *FMS) ListPoliciesWithContext(ctx aws.Context, input *ListPoliciesInput, opts ...request.Option) (*ListPoliciesOutput, error)

ListPoliciesWithContext is the same as ListPolicies with the addition of the ability to pass a context and additional request options.

See ListPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) ListTagsForResource added in v1.27.3 

func (c *FMS) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Firewall Management Service.

Retrieves the list of tags for the specified AWS resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

  • InvalidInputException The parameters of the request were invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListTagsForResource

func (*FMS) ListTagsForResourceRequest added in v1.27.3 

func (c *FMS) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListTagsForResource

func (*FMS) ListTagsForResourceWithContext added in v1.27.3 

func (c *FMS) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) PutNotificationChannel 

func (c *FMS) PutNotificationChannel(input *PutNotificationChannelInput) (*PutNotificationChannelOutput, error)

PutNotificationChannel API operation for Firewall Management Service.

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation PutNotificationChannel for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannel

func (*FMS) PutNotificationChannelRequest 

func (c *FMS) PutNotificationChannelRequest(input *PutNotificationChannelInput) (req *request.Request, output *PutNotificationChannelOutput)

PutNotificationChannelRequest generates a "aws/request.Request" representing the client's request for the PutNotificationChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutNotificationChannel for more information on using the PutNotificationChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutNotificationChannelRequest method.
req, resp := client.PutNotificationChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannel

func (*FMS) PutNotificationChannelWithContext 

func (c *FMS) PutNotificationChannelWithContext(ctx aws.Context, input *PutNotificationChannelInput, opts ...request.Option) (*PutNotificationChannelOutput, error)

PutNotificationChannelWithContext is the same as PutNotificationChannel with the addition of the ability to pass a context and additional request options.

See PutNotificationChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) PutPolicy 

func (c *FMS) PutPolicy(input *PutPolicyInput) (*PutPolicyOutput, error)

PutPolicy API operation for Firewall Management Service.

Creates an AWS Firewall Manager policy.

Firewall Manager provides the following types of policies:

  • A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources

  • An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.

  • An AWS WAF Classic policy (type WAF), which defines a rule group.

  • A security group policy, which manages VPC security groups across your AWS organization.

Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription (https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation PutPolicy for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InvalidInputException The parameters of the request were invalid.

  • LimitExceededException The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits (https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) in the AWS WAF Developer Guide.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

  • InvalidTypeException The value of the Type parameter is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicy

func (*FMS) PutPolicyRequest 

func (c *FMS) PutPolicyRequest(input *PutPolicyInput) (req *request.Request, output *PutPolicyOutput)

PutPolicyRequest generates a "aws/request.Request" representing the client's request for the PutPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPolicy for more information on using the PutPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutPolicyRequest method.
req, resp := client.PutPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicy

func (*FMS) PutPolicyWithContext 

func (c *FMS) PutPolicyWithContext(ctx aws.Context, input *PutPolicyInput, opts ...request.Option) (*PutPolicyOutput, error)

PutPolicyWithContext is the same as PutPolicy with the addition of the ability to pass a context and additional request options.

See PutPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) TagResource added in v1.27.3 

func (c *FMS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Firewall Management Service.

Adds one or more tags to an AWS resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

  • InvalidInputException The parameters of the request were invalid.

  • LimitExceededException The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits (https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) in the AWS WAF Developer Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/TagResource

func (*FMS) TagResourceRequest added in v1.27.3 

func (c *FMS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/TagResource

func (*FMS) TagResourceWithContext added in v1.27.3 

func (c *FMS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FMS) UntagResource added in v1.27.3 

func (c *FMS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Firewall Management Service.

Removes one or more tags from an AWS resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Firewall Management Service's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource was not found.

  • InvalidOperationException The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

  • InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.

  • InvalidInputException The parameters of the request were invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/UntagResource

func (*FMS) UntagResourceRequest added in v1.27.3 

func (c *FMS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/UntagResource

func (*FMS) UntagResourceWithContext added in v1.27.3 

func (c *FMS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type GetAdminAccountInput 

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

func (GetAdminAccountInput) GoString 

func (s GetAdminAccountInput) GoString() string

GoString returns the string representation

func (GetAdminAccountInput) String 

func (s GetAdminAccountInput) String() string

String returns the string representation

type GetAdminAccountOutput 

type GetAdminAccountOutput struct {

	// The AWS account that is set as the AWS Firewall Manager administrator.
	AdminAccount *string `min:"1" type:"string"`

	// The status of the AWS account that you set as the AWS Firewall Manager administrator.
	RoleStatus *string `type:"string" enum:"AccountRoleStatus"`
	// contains filtered or unexported fields
}

func (GetAdminAccountOutput) GoString 

func (s GetAdminAccountOutput) GoString() string

GoString returns the string representation

func (*GetAdminAccountOutput) SetAdminAccount 

func (s *GetAdminAccountOutput) SetAdminAccount(v string) *GetAdminAccountOutput

SetAdminAccount sets the AdminAccount field's value.

func (*GetAdminAccountOutput) SetRoleStatus added in v1.15.34 

func (s *GetAdminAccountOutput) SetRoleStatus(v string) *GetAdminAccountOutput

SetRoleStatus sets the RoleStatus field's value.

func (GetAdminAccountOutput) String 

func (s GetAdminAccountOutput) String() string

String returns the string representation

type GetComplianceDetailInput 

type GetComplianceDetailInput struct {

	// The AWS account that owns the resources that you want to get the details
	// for.
	//
	// MemberAccount is a required field
	MemberAccount *string `min:"1" type:"string" required:"true"`

	// The ID of the policy that you want to get the details for. PolicyId is returned
	// by PutPolicy and by ListPolicies.
	//
	// PolicyId is a required field
	PolicyId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetComplianceDetailInput) GoString 

func (s GetComplianceDetailInput) GoString() string

GoString returns the string representation

func (*GetComplianceDetailInput) SetMemberAccount 

func (s *GetComplianceDetailInput) SetMemberAccount(v string) *GetComplianceDetailInput

SetMemberAccount sets the MemberAccount field's value.

func (*GetComplianceDetailInput) SetPolicyId 

func (s *GetComplianceDetailInput) SetPolicyId(v string) *GetComplianceDetailInput

SetPolicyId sets the PolicyId field's value.

func (GetComplianceDetailInput) String 

func (s GetComplianceDetailInput) String() string

String returns the string representation

func (*GetComplianceDetailInput) Validate 

func (s *GetComplianceDetailInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetComplianceDetailOutput 

type GetComplianceDetailOutput struct {

	// Information about the resources and the policy that you specified in the
	// GetComplianceDetail request.
	PolicyComplianceDetail *PolicyComplianceDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (GetComplianceDetailOutput) GoString 

func (s GetComplianceDetailOutput) GoString() string

GoString returns the string representation

func (*GetComplianceDetailOutput) SetPolicyComplianceDetail 

func (s *GetComplianceDetailOutput) SetPolicyComplianceDetail(v *PolicyComplianceDetail) *GetComplianceDetailOutput

SetPolicyComplianceDetail sets the PolicyComplianceDetail field's value.

func (GetComplianceDetailOutput) String 

func (s GetComplianceDetailOutput) String() string

String returns the string representation

type GetNotificationChannelInput 

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

func (GetNotificationChannelInput) GoString 

func (s GetNotificationChannelInput) GoString() string

GoString returns the string representation

func (GetNotificationChannelInput) String 

func (s GetNotificationChannelInput) String() string

String returns the string representation

type GetNotificationChannelOutput 

type GetNotificationChannelOutput struct {

	// The IAM role that is used by AWS Firewall Manager to record activity to SNS.
	SnsRoleName *string `min:"1" type:"string"`

	// The SNS topic that records AWS Firewall Manager activity.
	SnsTopicArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetNotificationChannelOutput) GoString 

func (s GetNotificationChannelOutput) GoString() string

GoString returns the string representation

func (*GetNotificationChannelOutput) SetSnsRoleName 

func (s *GetNotificationChannelOutput) SetSnsRoleName(v string) *GetNotificationChannelOutput

SetSnsRoleName sets the SnsRoleName field's value.

func (*GetNotificationChannelOutput) SetSnsTopicArn 

func (s *GetNotificationChannelOutput) SetSnsTopicArn(v string) *GetNotificationChannelOutput

SetSnsTopicArn sets the SnsTopicArn field's value.

func (GetNotificationChannelOutput) String 

func (s GetNotificationChannelOutput) String() string

String returns the string representation

type GetPolicyInput 

type GetPolicyInput struct {

	// The ID of the AWS Firewall Manager policy that you want the details for.
	//
	// PolicyId is a required field
	PolicyId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPolicyInput) GoString 

func (s GetPolicyInput) GoString() string

GoString returns the string representation

func (*GetPolicyInput) SetPolicyId 

func (s *GetPolicyInput) SetPolicyId(v string) *GetPolicyInput

SetPolicyId sets the PolicyId field's value.

func (GetPolicyInput) String 

func (s GetPolicyInput) String() string

String returns the string representation

func (*GetPolicyInput) Validate 

func (s *GetPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPolicyOutput 

type GetPolicyOutput struct {

	// Information about the specified AWS Firewall Manager policy.
	Policy *Policy `type:"structure"`

	// The Amazon Resource Name (ARN) of the specified policy.
	PolicyArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetPolicyOutput) GoString 

func (s GetPolicyOutput) GoString() string

GoString returns the string representation

func (*GetPolicyOutput) SetPolicy 

func (s *GetPolicyOutput) SetPolicy(v *Policy) *GetPolicyOutput

SetPolicy sets the Policy field's value.

func (*GetPolicyOutput) SetPolicyArn 

func (s *GetPolicyOutput) SetPolicyArn(v string) *GetPolicyOutput

SetPolicyArn sets the PolicyArn field's value.

func (GetPolicyOutput) String 

func (s GetPolicyOutput) String() string

String returns the string representation

type GetProtectionStatusInput added in v1.19.4 

type GetProtectionStatusInput struct {

	// The end of the time period to query for the attacks. This is a timestamp
	// type. The request syntax listing indicates a number type because the default
	// used by AWS Firewall Manager is Unix time in seconds. However, any valid
	// timestamp format is allowed.
	EndTime *time.Time `type:"timestamp"`

	// Specifies the number of objects that you want AWS Firewall Manager to return
	// for this request. If you have more objects than the number that you specify
	// for MaxResults, the response includes a NextToken value that you can use
	// to get another batch of objects.
	MaxResults *int64 `min:"1" type:"integer"`

	// The AWS account that is in scope of the policy that you want to get the details
	// for.
	MemberAccountId *string `min:"1" type:"string"`

	// If you specify a value for MaxResults and you have more objects than the
	// number that you specify for MaxResults, AWS Firewall Manager returns a NextToken
	// value in the response, which you can use to retrieve another group of objects.
	// For the second and subsequent GetProtectionStatus requests, specify the value
	// of NextToken from the previous response to get information about another
	// batch of objects.
	NextToken *string `min:"1" type:"string"`

	// The ID of the policy for which you want to get the attack information.
	//
	// PolicyId is a required field
	PolicyId *string `min:"36" type:"string" required:"true"`

	// The start of the time period to query for the attacks. This is a timestamp
	// type. The request syntax listing indicates a number type because the default
	// used by AWS Firewall Manager is Unix time in seconds. However, any valid
	// timestamp format is allowed.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetProtectionStatusInput) GoString added in v1.19.4 

func (s GetProtectionStatusInput) GoString() string

GoString returns the string representation

func (*GetProtectionStatusInput) SetEndTime added in v1.19.4 

func (s *GetProtectionStatusInput) SetEndTime(v time.Time) *GetProtectionStatusInput

SetEndTime sets the EndTime field's value.

func (*GetProtectionStatusInput) SetMaxResults added in v1.19.4 

func (s *GetProtectionStatusInput) SetMaxResults(v int64) *GetProtectionStatusInput

SetMaxResults sets the MaxResults field's value.

func (*GetProtectionStatusInput) SetMemberAccountId added in v1.19.4 

func (s *GetProtectionStatusInput) SetMemberAccountId(v string) *GetProtectionStatusInput

SetMemberAccountId sets the MemberAccountId field's value.

func (*GetProtectionStatusInput) SetNextToken added in v1.19.4 

func (s *GetProtectionStatusInput) SetNextToken(v string) *GetProtectionStatusInput

SetNextToken sets the NextToken field's value.

func (*GetProtectionStatusInput) SetPolicyId added in v1.19.4 

func (s *GetProtectionStatusInput) SetPolicyId(v string) *GetProtectionStatusInput

SetPolicyId sets the PolicyId field's value.

func (*GetProtectionStatusInput) SetStartTime added in v1.19.4 

func (s *GetProtectionStatusInput) SetStartTime(v time.Time) *GetProtectionStatusInput

SetStartTime sets the StartTime field's value.

func (GetProtectionStatusInput) String added in v1.19.4 

func (s GetProtectionStatusInput) String() string

String returns the string representation

func (*GetProtectionStatusInput) Validate added in v1.19.4 

func (s *GetProtectionStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetProtectionStatusOutput added in v1.19.4 

type GetProtectionStatusOutput struct {

	// The ID of the AWS Firewall administrator account for this policy.
	AdminAccountId *string `min:"1" type:"string"`

	// Details about the attack, including the following:
	//
	//    * Attack type
	//
	//    * Account ID
	//
	//    * ARN of the resource attacked
	//
	//    * Start time of the attack
	//
	//    * End time of the attack (ongoing attacks will not have an end time)
	//
	// The details are in JSON format.
	Data *string `type:"string"`

	// If you have more objects than the number that you specified for MaxResults
	// in the request, the response includes a NextToken value. To list more objects,
	// submit another GetProtectionStatus request, and specify the NextToken value
	// from the response in the NextToken value in the next request.
	//
	// AWS SDKs provide auto-pagination that identify NextToken in a response and
	// make subsequent request calls automatically on your behalf. However, this
	// feature is not supported by GetProtectionStatus. You must submit subsequent
	// requests with NextToken using your own processes.
	NextToken *string `min:"1" type:"string"`

	// The service type that is protected by the policy. Currently, this is always
	// SHIELD_ADVANCED.
	ServiceType *string `type:"string" enum:"SecurityServiceType"`
	// contains filtered or unexported fields
}

func (GetProtectionStatusOutput) GoString added in v1.19.4 

func (s GetProtectionStatusOutput) GoString() string

GoString returns the string representation

func (*GetProtectionStatusOutput) SetAdminAccountId added in v1.19.4 

func (s *GetProtectionStatusOutput) SetAdminAccountId(v string) *GetProtectionStatusOutput

SetAdminAccountId sets the AdminAccountId field's value.

func (*GetProtectionStatusOutput) SetData added in v1.19.4 

func (s *GetProtectionStatusOutput) SetData(v string) *GetProtectionStatusOutput

SetData sets the Data field's value.

func (*GetProtectionStatusOutput) SetNextToken added in v1.19.4 

func (s *GetProtectionStatusOutput) SetNextToken(v string) *GetProtectionStatusOutput

SetNextToken sets the NextToken field's value.

func (*GetProtectionStatusOutput) SetServiceType added in v1.19.4 

func (s *GetProtectionStatusOutput) SetServiceType(v string) *GetProtectionStatusOutput

SetServiceType sets the ServiceType field's value.

func (GetProtectionStatusOutput) String added in v1.19.4 

func (s GetProtectionStatusOutput) String() string

String returns the string representation

type InternalErrorException added in v1.28.0 

type InternalErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation failed because of a system problem, even though the request was valid. Retry your request.

func (*InternalErrorException) Code added in v1.28.0 

func (s *InternalErrorException) Code() string

Code returns the exception type name.

func (*InternalErrorException) Error added in v1.28.0 

func (s *InternalErrorException) Error() string

func (InternalErrorException) GoString added in v1.28.0 

func (s InternalErrorException) GoString() string

GoString returns the string representation

func (*InternalErrorException) Message added in v1.28.0 

func (s *InternalErrorException) Message() string

Message returns the exception's message.

func (*InternalErrorException) OrigErr added in v1.28.0 

func (s *InternalErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalErrorException) RequestID added in v1.28.0 

func (s *InternalErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalErrorException) StatusCode added in v1.28.0 

func (s *InternalErrorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalErrorException) String added in v1.28.0 

func (s InternalErrorException) String() string

String returns the string representation

type InvalidInputException added in v1.28.0 

type InvalidInputException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The parameters of the request were invalid.

func (*InvalidInputException) Code added in v1.28.0 

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error added in v1.28.0 

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString added in v1.28.0 

func (s InvalidInputException) GoString() string

GoString returns the string representation

func (*InvalidInputException) Message added in v1.28.0 

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr added in v1.28.0 

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID added in v1.28.0 

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode added in v1.28.0 

func (s *InvalidInputException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidInputException) String added in v1.28.0 

func (s InvalidInputException) String() string

String returns the string representation

type InvalidOperationException added in v1.28.0 

type InvalidOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

func (*InvalidOperationException) Code added in v1.28.0 

func (s *InvalidOperationException) Code() string

Code returns the exception type name.

func (*InvalidOperationException) Error added in v1.28.0 

func (s *InvalidOperationException) Error() string

func (InvalidOperationException) GoString added in v1.28.0 

func (s InvalidOperationException) GoString() string

GoString returns the string representation

func (*InvalidOperationException) Message added in v1.28.0 

func (s *InvalidOperationException) Message() string

Message returns the exception's message.

func (*InvalidOperationException) OrigErr added in v1.28.0 

func (s *InvalidOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidOperationException) RequestID added in v1.28.0 

func (s *InvalidOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidOperationException) StatusCode added in v1.28.0 

func (s *InvalidOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidOperationException) String added in v1.28.0 

func (s InvalidOperationException) String() string

String returns the string representation

type InvalidTypeException added in v1.28.0 

type InvalidTypeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The value of the Type parameter is invalid.

func (*InvalidTypeException) Code added in v1.28.0 

func (s *InvalidTypeException) Code() string

Code returns the exception type name.

func (*InvalidTypeException) Error added in v1.28.0 

func (s *InvalidTypeException) Error() string

func (InvalidTypeException) GoString added in v1.28.0 

func (s InvalidTypeException) GoString() string

GoString returns the string representation

func (*InvalidTypeException) Message added in v1.28.0 

func (s *InvalidTypeException) Message() string

Message returns the exception's message.

func (*InvalidTypeException) OrigErr added in v1.28.0 

func (s *InvalidTypeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTypeException) RequestID added in v1.28.0 

func (s *InvalidTypeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTypeException) StatusCode added in v1.28.0 

func (s *InvalidTypeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidTypeException) String added in v1.28.0 

func (s InvalidTypeException) String() string

String returns the string representation

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits (https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html) in the AWS WAF Developer Guide.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation

type ListComplianceStatusInput 

type ListComplianceStatusInput struct {

	// Specifies the number of PolicyComplianceStatus objects that you want AWS
	// Firewall Manager to return for this request. If you have more PolicyComplianceStatus
	// objects than the number that you specify for MaxResults, the response includes
	// a NextToken value that you can use to get another batch of PolicyComplianceStatus
	// objects.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify a value for MaxResults and you have more PolicyComplianceStatus
	// objects than the number that you specify for MaxResults, AWS Firewall Manager
	// returns a NextToken value in the response that allows you to list another
	// group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus
	// requests, specify the value of NextToken from the previous response to get
	// information about another batch of PolicyComplianceStatus objects.
	NextToken *string `min:"1" type:"string"`

	// The ID of the AWS Firewall Manager policy that you want the details for.
	//
	// PolicyId is a required field
	PolicyId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListComplianceStatusInput) GoString 

func (s ListComplianceStatusInput) GoString() string

GoString returns the string representation

func (*ListComplianceStatusInput) SetMaxResults 

func (s *ListComplianceStatusInput) SetMaxResults(v int64) *ListComplianceStatusInput

SetMaxResults sets the MaxResults field's value.

func (*ListComplianceStatusInput) SetNextToken 

func (s *ListComplianceStatusInput) SetNextToken(v string) *ListComplianceStatusInput

SetNextToken sets the NextToken field's value.

func (*ListComplianceStatusInput) SetPolicyId 

func (s *ListComplianceStatusInput) SetPolicyId(v string) *ListComplianceStatusInput

SetPolicyId sets the PolicyId field's value.

func (ListComplianceStatusInput) String 

func (s ListComplianceStatusInput) String() string

String returns the string representation

func (*ListComplianceStatusInput) Validate 

func (s *ListComplianceStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComplianceStatusOutput 

type ListComplianceStatusOutput struct {

	// If you have more PolicyComplianceStatus objects than the number that you
	// specified for MaxResults in the request, the response includes a NextToken
	// value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus
	// request, and specify the NextToken value from the response in the NextToken
	// value in the next request.
	NextToken *string `min:"1" type:"string"`

	// An array of PolicyComplianceStatus objects.
	PolicyComplianceStatusList []*PolicyComplianceStatus `type:"list"`
	// contains filtered or unexported fields
}

func (ListComplianceStatusOutput) GoString 

func (s ListComplianceStatusOutput) GoString() string

GoString returns the string representation

func (*ListComplianceStatusOutput) SetNextToken 

func (s *ListComplianceStatusOutput) SetNextToken(v string) *ListComplianceStatusOutput

SetNextToken sets the NextToken field's value.

func (*ListComplianceStatusOutput) SetPolicyComplianceStatusList 

func (s *ListComplianceStatusOutput) SetPolicyComplianceStatusList(v []*PolicyComplianceStatus) *ListComplianceStatusOutput

SetPolicyComplianceStatusList sets the PolicyComplianceStatusList field's value.

func (ListComplianceStatusOutput) String 

func (s ListComplianceStatusOutput) String() string

String returns the string representation

type ListMemberAccountsInput added in v1.15.34 

type ListMemberAccountsInput struct {

	// Specifies the number of member account IDs that you want AWS Firewall Manager
	// to return for this request. If you have more IDs than the number that you
	// specify for MaxResults, the response includes a NextToken value that you
	// can use to get another batch of member account IDs.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify a value for MaxResults and you have more account IDs than
	// the number that you specify for MaxResults, AWS Firewall Manager returns
	// a NextToken value in the response that allows you to list another group of
	// IDs. For the second and subsequent ListMemberAccountsRequest requests, specify
	// the value of NextToken from the previous response to get information about
	// another batch of member account IDs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMemberAccountsInput) GoString added in v1.15.34 

func (s ListMemberAccountsInput) GoString() string

GoString returns the string representation

func (*ListMemberAccountsInput) SetMaxResults added in v1.15.34 

func (s *ListMemberAccountsInput) SetMaxResults(v int64) *ListMemberAccountsInput

SetMaxResults sets the MaxResults field's value.

func (*ListMemberAccountsInput) SetNextToken added in v1.15.34 

func (s *ListMemberAccountsInput) SetNextToken(v string) *ListMemberAccountsInput

SetNextToken sets the NextToken field's value.

func (ListMemberAccountsInput) String added in v1.15.34 

func (s ListMemberAccountsInput) String() string

String returns the string representation

func (*ListMemberAccountsInput) Validate added in v1.15.34 

func (s *ListMemberAccountsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMemberAccountsOutput added in v1.15.34 

type ListMemberAccountsOutput struct {

	// An array of account IDs.
	MemberAccounts []*string `type:"list"`

	// If you have more member account IDs than the number that you specified for
	// MaxResults in the request, the response includes a NextToken value. To list
	// more IDs, submit another ListMemberAccounts request, and specify the NextToken
	// value from the response in the NextToken value in the next request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMemberAccountsOutput) GoString added in v1.15.34 

func (s ListMemberAccountsOutput) GoString() string

GoString returns the string representation

func (*ListMemberAccountsOutput) SetMemberAccounts added in v1.15.34 

func (s *ListMemberAccountsOutput) SetMemberAccounts(v []*string) *ListMemberAccountsOutput

SetMemberAccounts sets the MemberAccounts field's value.

func (*ListMemberAccountsOutput) SetNextToken added in v1.15.34 

func (s *ListMemberAccountsOutput) SetNextToken(v string) *ListMemberAccountsOutput

SetNextToken sets the NextToken field's value.

func (ListMemberAccountsOutput) String added in v1.15.34 

func (s ListMemberAccountsOutput) String() string

String returns the string representation

type ListPoliciesInput 

type ListPoliciesInput struct {

	// Specifies the number of PolicySummary objects that you want AWS Firewall
	// Manager to return for this request. If you have more PolicySummary objects
	// than the number that you specify for MaxResults, the response includes a
	// NextToken value that you can use to get another batch of PolicySummary objects.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify a value for MaxResults and you have more PolicySummary objects
	// than the number that you specify for MaxResults, AWS Firewall Manager returns
	// a NextToken value in the response that allows you to list another group of
	// PolicySummary objects. For the second and subsequent ListPolicies requests,
	// specify the value of NextToken from the previous response to get information
	// about another batch of PolicySummary objects.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPoliciesInput) GoString 

func (s ListPoliciesInput) GoString() string

GoString returns the string representation

func (*ListPoliciesInput) SetMaxResults 

func (s *ListPoliciesInput) SetMaxResults(v int64) *ListPoliciesInput

SetMaxResults sets the MaxResults field's value.

func (*ListPoliciesInput) SetNextToken 

func (s *ListPoliciesInput) SetNextToken(v string) *ListPoliciesInput

SetNextToken sets the NextToken field's value.

func (ListPoliciesInput) String 

func (s ListPoliciesInput) String() string

String returns the string representation

func (*ListPoliciesInput) Validate 

func (s *ListPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPoliciesOutput 

type ListPoliciesOutput struct {

	// If you have more PolicySummary objects than the number that you specified
	// for MaxResults in the request, the response includes a NextToken value. To
	// list more PolicySummary objects, submit another ListPolicies request, and
	// specify the NextToken value from the response in the NextToken value in the
	// next request.
	NextToken *string `min:"1" type:"string"`

	// An array of PolicySummary objects.
	PolicyList []*PolicySummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListPoliciesOutput) GoString 

func (s ListPoliciesOutput) GoString() string

GoString returns the string representation

func (*ListPoliciesOutput) SetNextToken 

func (s *ListPoliciesOutput) SetNextToken(v string) *ListPoliciesOutput

SetNextToken sets the NextToken field's value.

func (*ListPoliciesOutput) SetPolicyList 

func (s *ListPoliciesOutput) SetPolicyList(v []*PolicySummary) *ListPoliciesOutput

SetPolicyList sets the PolicyList field's value.

func (ListPoliciesOutput) String 

func (s ListPoliciesOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.27.3 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall
	// Manager policy is the only AWS resource that supports tagging, so this ARN
	// is a policy ARN..
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.27.3 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn added in v1.27.3 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.27.3 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.27.3 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.27.3 

type ListTagsForResourceOutput struct {

	// The tags associated with the resource.
	TagList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.27.3 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTagList added in v1.27.3 

func (s *ListTagsForResourceOutput) SetTagList(v []*Tag) *ListTagsForResourceOutput

SetTagList sets the TagList field's value.

func (ListTagsForResourceOutput) String added in v1.27.3 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type Policy 

type Policy struct {

	// Specifies the AWS account IDs and AWS Organizations organizational units
	// (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying
	// all accounts in the OU and in any of its child OUs, including any child OUs
	// and accounts that are added at a later time.
	//
	// You can specify inclusions or exclusions, but not both. If you specify an
	// IncludeMap, AWS Firewall Manager applies the policy to all accounts specified
	// by the IncludeMap, and does not evaluate any ExcludeMap specifications. If
	// you do not specify an IncludeMap, then Firewall Manager applies the policy
	// to all accounts except for those specified by the ExcludeMap.
	//
	// You can specify account IDs, OUs, or a combination:
	//
	//    * Specify account IDs by setting the key to ACCOUNT. For example, the
	//    following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
	//
	//    * Specify OUs by setting the key to ORG_UNIT. For example, the following
	//    is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.
	//
	//    * Specify accounts and OUs together in a single map, separated with a
	//    comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”,
	//    “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
	ExcludeMap map[string][]*string `type:"map"`

	// If set to True, resources with the tags that are specified in the ResourceTag
	// array are not in scope of the policy. If set to False, and the ResourceTag
	// array is not null, only resources with the specified tags are in scope of
	// the policy.
	//
	// ExcludeResourceTags is a required field
	ExcludeResourceTags *bool `type:"boolean" required:"true"`

	// Specifies the AWS account IDs and AWS Organizations organizational units
	// (OUs) to include in the policy. Specifying an OU is the equivalent of specifying
	// all accounts in the OU and in any of its child OUs, including any child OUs
	// and accounts that are added at a later time.
	//
	// You can specify inclusions or exclusions, but not both. If you specify an
	// IncludeMap, AWS Firewall Manager applies the policy to all accounts specified
	// by the IncludeMap, and does not evaluate any ExcludeMap specifications. If
	// you do not specify an IncludeMap, then Firewall Manager applies the policy
	// to all accounts except for those specified by the ExcludeMap.
	//
	// You can specify account IDs, OUs, or a combination:
	//
	//    * Specify account IDs by setting the key to ACCOUNT. For example, the
	//    following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
	//
	//    * Specify OUs by setting the key to ORG_UNIT. For example, the following
	//    is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.
	//
	//    * Specify accounts and OUs together in a single map, separated with a
	//    comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”,
	//    “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
	IncludeMap map[string][]*string `type:"map"`

	// The ID of the AWS Firewall Manager policy.
	PolicyId *string `min:"36" type:"string"`

	// The friendly name of the AWS Firewall Manager policy.
	//
	// PolicyName is a required field
	PolicyName *string `min:"1" type:"string" required:"true"`

	// A unique identifier for each update to the policy. When issuing a PutPolicy
	// request, the PolicyUpdateToken in the request must match the PolicyUpdateToken
	// of the current policy version. To get the PolicyUpdateToken of the current
	// policy version, use a GetPolicy request.
	PolicyUpdateToken *string `min:"1" type:"string"`

	// Indicates if the policy should be automatically applied to new resources.
	//
	// RemediationEnabled is a required field
	RemediationEnabled *bool `type:"boolean" required:"true"`

	// An array of ResourceTag objects.
	ResourceTags []*ResourceTag `type:"list"`

	// The type of resource protected by or in scope of the policy. This is in the
	// format shown in the AWS Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).
	// For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer
	// and AWS::CloudFront::Distribution. For a security group common policy, valid
	// values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security
	// group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface,
	// and AWS::EC2::Instance. For a security group usage audit policy, the value
	// is AWS::EC2::SecurityGroup.
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`

	// An array of ResourceType.
	ResourceTypeList []*string `type:"list"`

	// Details about the security service that is being used to protect the resources.
	//
	// SecurityServicePolicyData is a required field
	SecurityServicePolicyData *SecurityServicePolicyData `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

An AWS Firewall Manager policy.

func (Policy) GoString 

func (s Policy) GoString() string

GoString returns the string representation

func (*Policy) SetExcludeMap added in v1.15.34 

func (s *Policy) SetExcludeMap(v map[string][]*string) *Policy

SetExcludeMap sets the ExcludeMap field's value.

func (*Policy) SetExcludeResourceTags 

func (s *Policy) SetExcludeResourceTags(v bool) *Policy

SetExcludeResourceTags sets the ExcludeResourceTags field's value.

func (*Policy) SetIncludeMap added in v1.15.34 

func (s *Policy) SetIncludeMap(v map[string][]*string) *Policy

SetIncludeMap sets the IncludeMap field's value.

func (*Policy) SetPolicyId 

func (s *Policy) SetPolicyId(v string) *Policy

SetPolicyId sets the PolicyId field's value.

func (*Policy) SetPolicyName 

func (s *Policy) SetPolicyName(v string) *Policy

SetPolicyName sets the PolicyName field's value.

func (*Policy) SetPolicyUpdateToken 

func (s *Policy) SetPolicyUpdateToken(v string) *Policy

SetPolicyUpdateToken sets the PolicyUpdateToken field's value.

func (*Policy) SetRemediationEnabled 

func (s *Policy) SetRemediationEnabled(v bool) *Policy

SetRemediationEnabled sets the RemediationEnabled field's value.

func (*Policy) SetResourceTags 

func (s *Policy) SetResourceTags(v []*ResourceTag) *Policy

SetResourceTags sets the ResourceTags field's value.

func (*Policy) SetResourceType 

func (s *Policy) SetResourceType(v string) *Policy

SetResourceType sets the ResourceType field's value.

func (*Policy) SetResourceTypeList added in v1.19.4 

func (s *Policy) SetResourceTypeList(v []*string) *Policy

SetResourceTypeList sets the ResourceTypeList field's value.

func (*Policy) SetSecurityServicePolicyData 

func (s *Policy) SetSecurityServicePolicyData(v *SecurityServicePolicyData) *Policy

SetSecurityServicePolicyData sets the SecurityServicePolicyData field's value.

func (Policy) String 

func (s Policy) String() string

String returns the string representation

func (*Policy) Validate 

func (s *Policy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PolicyComplianceDetail 

type PolicyComplianceDetail struct {

	// Indicates if over 100 resources are noncompliant with the AWS Firewall Manager
	// policy.
	EvaluationLimitExceeded *bool `type:"boolean"`

	// A timestamp that indicates when the returned information should be considered
	// out of date.
	ExpiredAt *time.Time `type:"timestamp"`

	// Details about problems with dependent services, such as AWS WAF or AWS Config,
	// that are causing a resource to be noncompliant. The details include the name
	// of the dependent service and the error message received that indicates the
	// problem with the service.
	IssueInfoMap map[string]*string `type:"map"`

	// The AWS account ID.
	MemberAccount *string `min:"1" type:"string"`

	// The ID of the AWS Firewall Manager policy.
	PolicyId *string `min:"36" type:"string"`

	// The AWS account that created the AWS Firewall Manager policy.
	PolicyOwner *string `min:"1" type:"string"`

	// An array of resources that aren't protected by the AWS WAF or Shield Advanced
	// policy or that aren't in compliance with the security group policy.
	Violators []*ComplianceViolator `type:"list"`
	// contains filtered or unexported fields
}

Describes the noncompliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant, EvaluationLimitExceeded is set to True.

func (PolicyComplianceDetail) GoString 

func (s PolicyComplianceDetail) GoString() string

GoString returns the string representation

func (*PolicyComplianceDetail) SetEvaluationLimitExceeded 

func (s *PolicyComplianceDetail) SetEvaluationLimitExceeded(v bool) *PolicyComplianceDetail

SetEvaluationLimitExceeded sets the EvaluationLimitExceeded field's value.

func (*PolicyComplianceDetail) SetExpiredAt 

func (s *PolicyComplianceDetail) SetExpiredAt(v time.Time) *PolicyComplianceDetail

SetExpiredAt sets the ExpiredAt field's value.

func (*PolicyComplianceDetail) SetIssueInfoMap added in v1.15.34 

func (s *PolicyComplianceDetail) SetIssueInfoMap(v map[string]*string) *PolicyComplianceDetail

SetIssueInfoMap sets the IssueInfoMap field's value.

func (*PolicyComplianceDetail) SetMemberAccount 

func (s *PolicyComplianceDetail) SetMemberAccount(v string) *PolicyComplianceDetail

SetMemberAccount sets the MemberAccount field's value.

func (*PolicyComplianceDetail) SetPolicyId 

func (s *PolicyComplianceDetail) SetPolicyId(v string) *PolicyComplianceDetail

SetPolicyId sets the PolicyId field's value.

func (*PolicyComplianceDetail) SetPolicyOwner 

func (s *PolicyComplianceDetail) SetPolicyOwner(v string) *PolicyComplianceDetail

SetPolicyOwner sets the PolicyOwner field's value.

func (*PolicyComplianceDetail) SetViolators 

func (s *PolicyComplianceDetail) SetViolators(v []*ComplianceViolator) *PolicyComplianceDetail

SetViolators sets the Violators field's value.

func (PolicyComplianceDetail) String 

func (s PolicyComplianceDetail) String() string

String returns the string representation

type PolicyComplianceStatus 

type PolicyComplianceStatus struct {

	// An array of EvaluationResult objects.
	EvaluationResults []*EvaluationResult `type:"list"`

	// Details about problems with dependent services, such as AWS WAF or AWS Config,
	// that are causing a resource to be noncompliant. The details include the name
	// of the dependent service and the error message received that indicates the
	// problem with the service.
	IssueInfoMap map[string]*string `type:"map"`

	// Timestamp of the last update to the EvaluationResult objects.
	LastUpdated *time.Time `type:"timestamp"`

	// The member account ID.
	MemberAccount *string `min:"1" type:"string"`

	// The ID of the AWS Firewall Manager policy.
	PolicyId *string `min:"36" type:"string"`

	// The friendly name of the AWS Firewall Manager policy.
	PolicyName *string `min:"1" type:"string"`

	// The AWS account that created the AWS Firewall Manager policy.
	PolicyOwner *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for AWS WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

func (PolicyComplianceStatus) GoString 

func (s PolicyComplianceStatus) GoString() string

GoString returns the string representation

func (*PolicyComplianceStatus) SetEvaluationResults 

func (s *PolicyComplianceStatus) SetEvaluationResults(v []*EvaluationResult) *PolicyComplianceStatus

SetEvaluationResults sets the EvaluationResults field's value.

func (*PolicyComplianceStatus) SetIssueInfoMap added in v1.15.34 

func (s *PolicyComplianceStatus) SetIssueInfoMap(v map[string]*string) *PolicyComplianceStatus

SetIssueInfoMap sets the IssueInfoMap field's value.

func (*PolicyComplianceStatus) SetLastUpdated 

func (s *PolicyComplianceStatus) SetLastUpdated(v time.Time) *PolicyComplianceStatus

SetLastUpdated sets the LastUpdated field's value.

func (*PolicyComplianceStatus) SetMemberAccount 

func (s *PolicyComplianceStatus) SetMemberAccount(v string) *PolicyComplianceStatus

SetMemberAccount sets the MemberAccount field's value.

func (*PolicyComplianceStatus) SetPolicyId 

func (s *PolicyComplianceStatus) SetPolicyId(v string) *PolicyComplianceStatus

SetPolicyId sets the PolicyId field's value.

func (*PolicyComplianceStatus) SetPolicyName 

func (s *PolicyComplianceStatus) SetPolicyName(v string) *PolicyComplianceStatus

SetPolicyName sets the PolicyName field's value.

func (*PolicyComplianceStatus) SetPolicyOwner 

func (s *PolicyComplianceStatus) SetPolicyOwner(v string) *PolicyComplianceStatus

SetPolicyOwner sets the PolicyOwner field's value.

func (PolicyComplianceStatus) String 

func (s PolicyComplianceStatus) String() string

String returns the string representation

type PolicySummary 

type PolicySummary struct {

	// The Amazon Resource Name (ARN) of the specified policy.
	PolicyArn *string `min:"1" type:"string"`

	// The ID of the specified policy.
	PolicyId *string `min:"36" type:"string"`

	// The friendly name of the specified policy.
	PolicyName *string `min:"1" type:"string"`

	// Indicates if the policy should be automatically applied to new resources.
	RemediationEnabled *bool `type:"boolean"`

	// The type of resource protected by or in scope of the policy. This is in the
	// format shown in the AWS Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).
	// For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer
	// and AWS::CloudFront::Distribution. For a security group common policy, valid
	// values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security
	// group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface,
	// and AWS::EC2::Instance. For a security group usage audit policy, the value
	// is AWS::EC2::SecurityGroup.
	ResourceType *string `min:"1" type:"string"`

	// The service that the policy is using to protect the resources. This specifies
	// the type of policy that is created, either an AWS WAF policy, a Shield Advanced
	// policy, or a security group policy.
	SecurityServiceType *string `type:"string" enum:"SecurityServiceType"`
	// contains filtered or unexported fields
}

Details of the AWS Firewall Manager policy.

func (PolicySummary) GoString 

func (s PolicySummary) GoString() string

GoString returns the string representation

func (*PolicySummary) SetPolicyArn 

func (s *PolicySummary) SetPolicyArn(v string) *PolicySummary

SetPolicyArn sets the PolicyArn field's value.

func (*PolicySummary) SetPolicyId 

func (s *PolicySummary) SetPolicyId(v string) *PolicySummary

SetPolicyId sets the PolicyId field's value.

func (*PolicySummary) SetPolicyName 

func (s *PolicySummary) SetPolicyName(v string) *PolicySummary

SetPolicyName sets the PolicyName field's value.

func (*PolicySummary) SetRemediationEnabled 

func (s *PolicySummary) SetRemediationEnabled(v bool) *PolicySummary

SetRemediationEnabled sets the RemediationEnabled field's value.

func (*PolicySummary) SetResourceType 

func (s *PolicySummary) SetResourceType(v string) *PolicySummary

SetResourceType sets the ResourceType field's value.

func (*PolicySummary) SetSecurityServiceType 

func (s *PolicySummary) SetSecurityServiceType(v string) *PolicySummary

SetSecurityServiceType sets the SecurityServiceType field's value.

func (PolicySummary) String 

func (s PolicySummary) String() string

String returns the string representation

type PutNotificationChannelInput 

type PutNotificationChannelInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to
	// record AWS Firewall Manager activity.
	//
	// SnsRoleName is a required field
	SnsRoleName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the SNS topic that collects notifications
	// from AWS Firewall Manager.
	//
	// SnsTopicArn is a required field
	SnsTopicArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutNotificationChannelInput) GoString 

func (s PutNotificationChannelInput) GoString() string

GoString returns the string representation

func (*PutNotificationChannelInput) SetSnsRoleName 

func (s *PutNotificationChannelInput) SetSnsRoleName(v string) *PutNotificationChannelInput

SetSnsRoleName sets the SnsRoleName field's value.

func (*PutNotificationChannelInput) SetSnsTopicArn 

func (s *PutNotificationChannelInput) SetSnsTopicArn(v string) *PutNotificationChannelInput

SetSnsTopicArn sets the SnsTopicArn field's value.

func (PutNotificationChannelInput) String 

func (s PutNotificationChannelInput) String() string

String returns the string representation

func (*PutNotificationChannelInput) Validate 

func (s *PutNotificationChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutNotificationChannelOutput 

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

func (PutNotificationChannelOutput) GoString 

func (s PutNotificationChannelOutput) GoString() string

GoString returns the string representation

func (PutNotificationChannelOutput) String 

func (s PutNotificationChannelOutput) String() string

String returns the string representation

type PutPolicyInput 

type PutPolicyInput struct {

	// The details of the AWS Firewall Manager policy to be created.
	//
	// Policy is a required field
	Policy *Policy `type:"structure" required:"true"`

	// The tags to add to the AWS resource.
	TagList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (PutPolicyInput) GoString 

func (s PutPolicyInput) GoString() string

GoString returns the string representation

func (*PutPolicyInput) SetPolicy 

func (s *PutPolicyInput) SetPolicy(v *Policy) *PutPolicyInput

SetPolicy sets the Policy field's value.

func (*PutPolicyInput) SetTagList added in v1.27.3 

func (s *PutPolicyInput) SetTagList(v []*Tag) *PutPolicyInput

SetTagList sets the TagList field's value.

func (PutPolicyInput) String 

func (s PutPolicyInput) String() string

String returns the string representation

func (*PutPolicyInput) Validate 

func (s *PutPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPolicyOutput 

type PutPolicyOutput struct {

	// The details of the AWS Firewall Manager policy that was created.
	Policy *Policy `type:"structure"`

	// The Amazon Resource Name (ARN) of the policy that was created.
	PolicyArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutPolicyOutput) GoString 

func (s PutPolicyOutput) GoString() string

GoString returns the string representation

func (*PutPolicyOutput) SetPolicy 

func (s *PutPolicyOutput) SetPolicy(v *Policy) *PutPolicyOutput

SetPolicy sets the Policy field's value.

func (*PutPolicyOutput) SetPolicyArn 

func (s *PutPolicyOutput) SetPolicyArn(v string) *PutPolicyOutput

SetPolicyArn sets the PolicyArn field's value.

func (PutPolicyOutput) String 

func (s PutPolicyOutput) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource was not found.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResourceTag 

type ResourceTag struct {

	// The resource tag key.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The resource tag value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor (https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html).

func (ResourceTag) GoString 

func (s ResourceTag) GoString() string

GoString returns the string representation

func (*ResourceTag) SetKey 

func (s *ResourceTag) SetKey(v string) *ResourceTag

SetKey sets the Key field's value.

func (*ResourceTag) SetValue 

func (s *ResourceTag) SetValue(v string) *ResourceTag

SetValue sets the Value field's value.

func (ResourceTag) String 

func (s ResourceTag) String() string

String returns the string representation

func (*ResourceTag) Validate 

func (s *ResourceTag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SecurityServicePolicyData 

type SecurityServicePolicyData struct {

	// Details about the service that are specific to the service type, in JSON
	// format. For service type SHIELD_ADVANCED, this is an empty string.
	//
	//    * Example: WAFV2 "ManagedServiceData": "{\"type\":\"WAFV2\",\"defaultAction\":{\"type\":\"ALLOW\"},\"preProcessRuleGroups\":[{\"managedRuleGroupIdentifier\":null,\"ruleGroupArn\":\"rulegrouparn\",\"overrideAction\":{\"type\":\"COUNT\"},\"excludedRules\":[{\"name\":\"EntityName\"}],\"ruleGroupType\":\"RuleGroup\"}],\"postProcessRuleGroups\":[{\"managedRuleGroupIdentifier\":{\"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\",\"vendor\":\"AWS\"},\"ruleGroupArn\":\"rulegrouparn\",\"overrideAction\":{\"type\":\"NONE\"},\"excludedRules\":[],\"ruleGroupType\":\"ManagedRuleGroup\"}],\"overrideCustomerWebACLAssociation\":false}"
	//
	//    * Example: WAF Classic "ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\":
	//    [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\"
	//    : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}
	//
	//    * Example: SECURITY_GROUPS_COMMON "SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_COMMON","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false,
	//    \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"},"RemediationEnabled":false,"ResourceType":"AWS::EC2::NetworkInterface"}
	//
	//    * Example: SECURITY_GROUPS_CONTENT_AUDIT "SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_CONTENT_AUDIT","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"
	//    sg-000e55995d61a06bd \"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"},"RemediationEnabled":false,"ResourceType":"AWS::EC2::NetworkInterface"}
	//    The security group action for content audit can be ALLOW or DENY. For
	//    ALLOW, all in-scope security group rules must be within the allowed range
	//    of the policy's security group rules. For DENY, all in-scope security
	//    group rules must not contain a value or a range that matches a rule value
	//    or range in the policy security group.
	//
	//    * Example: SECURITY_GROUPS_USAGE_AUDIT "SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_USAGE_AUDIT","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"},"RemediationEnabled":false,"Resou
	//    rceType":"AWS::EC2::SecurityGroup"}
	ManagedServiceData *string `min:"1" type:"string"`

	// The service that the policy is using to protect the resources. This specifies
	// the type of policy that is created, either an AWS WAF policy, a Shield Advanced
	// policy, or a security group policy. For security group policies, Firewall
	// Manager supports one security group for each common policy and for each content
	// audit policy. This is an adjustable limit that you can increase by contacting
	// AWS Support.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"SecurityServiceType"`
	// contains filtered or unexported fields
}

Details about the security service that is being used to protect the resources.

func (SecurityServicePolicyData) GoString 

func (s SecurityServicePolicyData) GoString() string

GoString returns the string representation

func (*SecurityServicePolicyData) SetManagedServiceData 

func (s *SecurityServicePolicyData) SetManagedServiceData(v string) *SecurityServicePolicyData

SetManagedServiceData sets the ManagedServiceData field's value.

func (*SecurityServicePolicyData) SetType 

func (s *SecurityServicePolicyData) SetType(v string) *SecurityServicePolicyData

SetType sets the Type field's value.

func (SecurityServicePolicyData) String 

func (s SecurityServicePolicyData) String() string

String returns the string representation

func (*SecurityServicePolicyData) Validate 

func (s *SecurityServicePolicyData) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag added in v1.27.3 

type Tag struct {

	// Part of the key:value pair that defines a tag. You can use a tag key to describe
	// a category of information, such as "customer." Tag keys are case-sensitive.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Part of the key:value pair that defines a tag. You can use a tag value to
	// describe a specific value within a category, such as "companyA" or "companyB."
	// Tag values are case-sensitive.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

func (Tag) GoString added in v1.27.3 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.27.3 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.27.3 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.27.3 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.27.3 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.27.3 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. The Firewall Manager policy
	// is the only AWS resource that supports tagging, so this ARN is a policy ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// The tags to add to the resource.
	//
	// TagList is a required field
	TagList []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.27.3 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn added in v1.27.3 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTagList added in v1.27.3 

func (s *TagResourceInput) SetTagList(v []*Tag) *TagResourceInput

SetTagList sets the TagList field's value.

func (TagResourceInput) String added in v1.27.3 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.27.3 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.27.3 

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

func (TagResourceOutput) GoString added in v1.27.3 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.27.3 

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput added in v1.27.3 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. The Firewall Manager policy
	// is the only AWS resource that supports tagging, so this ARN is a policy ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// The keys of the tags to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.27.3 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn added in v1.27.3 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.27.3 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.27.3 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.27.3 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.27.3 

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

func (UntagResourceOutput) GoString added in v1.27.3 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.27.3 

func (s UntagResourceOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package fmsiface provides an interface to enable mocking the Firewall Management Service service client for testing your code.
 Package fmsiface provides an interface to enable mocking the Firewall Management Service service client for testing your code.

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.