aws-sdk-go: github.com/aws/aws-sdk-go/service/fms Index | Files | Directories

package fms

import "github.com/aws/aws-sdk-go/service/fms"

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

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
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"
)
const (
    // PolicyComplianceStatusTypeCompliant is a PolicyComplianceStatusType enum value
    PolicyComplianceStatusTypeCompliant = "COMPLIANT"

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

    // SecurityServiceTypeShieldAdvanced is a SecurityServiceType enum value
    SecurityServiceTypeShieldAdvanced = "SHIELD_ADVANCED"
)
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"
)
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"
)
const (
    ServiceName = "fms"       // Name of service.
    EndpointsID = ServiceName // ID to lookup a service endpoint with.
    ServiceID   = "FMS"       // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // CustomerPolicyScopeIdTypeAccount is a CustomerPolicyScopeIdType enum value
    CustomerPolicyScopeIdTypeAccount = "ACCOUNT"
)

type AssociateAdminAccountInput Uses

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 Uses

func (s AssociateAdminAccountInput) GoString() string

GoString returns the string representation

func (*AssociateAdminAccountInput) SetAdminAccount Uses

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

SetAdminAccount sets the AdminAccount field's value.

func (AssociateAdminAccountInput) String Uses

func (s AssociateAdminAccountInput) String() string

String returns the string representation

func (*AssociateAdminAccountInput) Validate Uses

func (s *AssociateAdminAccountInput) Validate() error

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

type AssociateAdminAccountOutput Uses

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

func (AssociateAdminAccountOutput) GoString Uses

func (s AssociateAdminAccountOutput) GoString() string

GoString returns the string representation

func (AssociateAdminAccountOutput) String Uses

func (s AssociateAdminAccountOutput) String() string

String returns the string representation

type ComplianceViolator Uses

type ComplianceViolator struct {

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

    // The resource type. This is in the format shown in 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 Uses

func (s ComplianceViolator) GoString() string

GoString returns the string representation

func (*ComplianceViolator) SetResourceId Uses

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

SetResourceId sets the ResourceId field's value.

func (*ComplianceViolator) SetResourceType Uses

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

SetResourceType sets the ResourceType field's value.

func (*ComplianceViolator) SetViolationReason Uses

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

SetViolationReason sets the ViolationReason field's value.

func (ComplianceViolator) String Uses

func (s ComplianceViolator) String() string

String returns the string representation

type DeleteNotificationChannelInput Uses

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

func (DeleteNotificationChannelInput) GoString Uses

func (s DeleteNotificationChannelInput) GoString() string

GoString returns the string representation

func (DeleteNotificationChannelInput) String Uses

func (s DeleteNotificationChannelInput) String() string

String returns the string representation

type DeleteNotificationChannelOutput Uses

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

func (DeleteNotificationChannelOutput) GoString Uses

func (s DeleteNotificationChannelOutput) GoString() string

GoString returns the string representation

func (DeleteNotificationChannelOutput) String Uses

func (s DeleteNotificationChannelOutput) String() string

String returns the string representation

type DeletePolicyInput Uses

type DeletePolicyInput struct {

    // If True, the request will also perform a clean-up process that will:
    //
    //    * Delete rule groups created by AWS Firewall Manager
    //
    //    * Remove web ACLs from in-scope resources
    //
    //    * Delete web ACLs that contain no rules or rule groups
    //
    // After the cleanup, in-scope resources will no longer be protected by web
    // ACLs in this policy. Protection of out-of-scope resources will remain unchanged.
    // Scope is determined by tags and accounts associated with the policy. When
    // creating the policy, if you specified that only resources in specific accounts
    // or with specific tags be protected by the policy, those resources are in-scope.
    // All others are out of scope. If you did not 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 Uses

func (s DeletePolicyInput) GoString() string

GoString returns the string representation

func (*DeletePolicyInput) SetDeleteAllPolicyResources Uses

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

SetDeleteAllPolicyResources sets the DeleteAllPolicyResources field's value.

func (*DeletePolicyInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (DeletePolicyInput) String Uses

func (s DeletePolicyInput) String() string

String returns the string representation

func (*DeletePolicyInput) Validate Uses

func (s *DeletePolicyInput) Validate() error

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

type DeletePolicyOutput Uses

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

func (DeletePolicyOutput) GoString Uses

func (s DeletePolicyOutput) GoString() string

GoString returns the string representation

func (DeletePolicyOutput) String Uses

func (s DeletePolicyOutput) String() string

String returns the string representation

type DisassociateAdminAccountInput Uses

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

func (DisassociateAdminAccountInput) GoString Uses

func (s DisassociateAdminAccountInput) GoString() string

GoString returns the string representation

func (DisassociateAdminAccountInput) String Uses

func (s DisassociateAdminAccountInput) String() string

String returns the string representation

type DisassociateAdminAccountOutput Uses

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

func (DisassociateAdminAccountOutput) GoString Uses

func (s DisassociateAdminAccountOutput) GoString() string

GoString returns the string representation

func (DisassociateAdminAccountOutput) String Uses

func (s DisassociateAdminAccountOutput) String() string

String returns the string representation

type EvaluationResult Uses

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 non-compliant with the AWS Firewall
    // Manager policy.
    EvaluationLimitExceeded *bool `type:"boolean"`

    // Number of resources that are non-compliant with the specified policy. A resource
    // is considered non-compliant if it is not associated with the specified policy.
    ViolatorCount *int64 `type:"long"`
    // contains filtered or unexported fields
}

Describes the compliance status for the account. An account is considered non-compliant if it includes resources that are not protected by the specified policy.

func (EvaluationResult) GoString Uses

func (s EvaluationResult) GoString() string

GoString returns the string representation

func (*EvaluationResult) SetComplianceStatus Uses

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

SetComplianceStatus sets the ComplianceStatus field's value.

func (*EvaluationResult) SetEvaluationLimitExceeded Uses

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

SetEvaluationLimitExceeded sets the EvaluationLimitExceeded field's value.

func (*EvaluationResult) SetViolatorCount Uses

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

SetViolatorCount sets the ViolatorCount field's value.

func (EvaluationResult) String Uses

func (s EvaluationResult) String() string

String returns the string representation

type FMS Uses

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 Uses

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:

// 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 Uses

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 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 Codes:

* ErrCodeInvalidOperationException "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.

* ErrCodeInvalidInputException "InvalidInputException"
The parameters of the request were invalid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInvalidOperationException "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.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInvalidOperationException "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.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidOperationException "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.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidOperationException "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.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 non-compliant if the specified policy has not been applied to them.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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

GetNotificationChannel API operation for Firewall Management Service.

Returns 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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInvalidOperationException "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.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInvalidOperationException "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.

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

* ErrCodeInvalidTypeException "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 Uses

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 Uses

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 Uses

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.

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 Codes:

* ErrCodeInvalidInputException "InvalidInputException"
The parameters of the request were invalid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInvalidOperationException "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.

* ErrCodeLimitExceededException "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.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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 Uses

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) PutNotificationChannel Uses

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInvalidOperationException "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.

* ErrCodeInternalErrorException "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 Uses

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 Uses

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 Uses

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

PutPolicy API operation for Firewall Management Service.

Creates an AWS Firewall Manager policy.

Firewall Manager provides two types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources, or a WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. A policy is specific to either WAF or Shield Advanced. If you want to enforce both WAF rules and Shield Advanced protection across accounts, you can create multiple policies. You can create one or more policies for WAF rules, and one or more policies for Shield Advanced.

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information on 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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
The specified resource was not found.

* ErrCodeInvalidOperationException "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.

* ErrCodeInvalidInputException "InvalidInputException"
The parameters of the request were invalid.

* ErrCodeLimitExceededException "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.

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

* ErrCodeInvalidTypeException "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 Uses

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 Uses

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.

type GetAdminAccountInput Uses

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

func (GetAdminAccountInput) GoString Uses

func (s GetAdminAccountInput) GoString() string

GoString returns the string representation

func (GetAdminAccountInput) String Uses

func (s GetAdminAccountInput) String() string

String returns the string representation

type GetAdminAccountOutput Uses

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 Uses

func (s GetAdminAccountOutput) GoString() string

GoString returns the string representation

func (*GetAdminAccountOutput) SetAdminAccount Uses

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

SetAdminAccount sets the AdminAccount field's value.

func (*GetAdminAccountOutput) SetRoleStatus Uses

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

SetRoleStatus sets the RoleStatus field's value.

func (GetAdminAccountOutput) String Uses

func (s GetAdminAccountOutput) String() string

String returns the string representation

type GetComplianceDetailInput Uses

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 Uses

func (s GetComplianceDetailInput) GoString() string

GoString returns the string representation

func (*GetComplianceDetailInput) SetMemberAccount Uses

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

SetMemberAccount sets the MemberAccount field's value.

func (*GetComplianceDetailInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (GetComplianceDetailInput) String Uses

func (s GetComplianceDetailInput) String() string

String returns the string representation

func (*GetComplianceDetailInput) Validate Uses

func (s *GetComplianceDetailInput) Validate() error

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

type GetComplianceDetailOutput Uses

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 Uses

func (s GetComplianceDetailOutput) GoString() string

GoString returns the string representation

func (*GetComplianceDetailOutput) SetPolicyComplianceDetail Uses

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

SetPolicyComplianceDetail sets the PolicyComplianceDetail field's value.

func (GetComplianceDetailOutput) String Uses

func (s GetComplianceDetailOutput) String() string

String returns the string representation

type GetNotificationChannelInput Uses

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

func (GetNotificationChannelInput) GoString Uses

func (s GetNotificationChannelInput) GoString() string

GoString returns the string representation

func (GetNotificationChannelInput) String Uses

func (s GetNotificationChannelInput) String() string

String returns the string representation

type GetNotificationChannelOutput Uses

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 Uses

func (s GetNotificationChannelOutput) GoString() string

GoString returns the string representation

func (*GetNotificationChannelOutput) SetSnsRoleName Uses

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

SetSnsRoleName sets the SnsRoleName field's value.

func (*GetNotificationChannelOutput) SetSnsTopicArn Uses

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

SetSnsTopicArn sets the SnsTopicArn field's value.

func (GetNotificationChannelOutput) String Uses

func (s GetNotificationChannelOutput) String() string

String returns the string representation

type GetPolicyInput Uses

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 Uses

func (s GetPolicyInput) GoString() string

GoString returns the string representation

func (*GetPolicyInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (GetPolicyInput) String Uses

func (s GetPolicyInput) String() string

String returns the string representation

func (*GetPolicyInput) Validate Uses

func (s *GetPolicyInput) Validate() error

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

type GetPolicyOutput Uses

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 Uses

func (s GetPolicyOutput) GoString() string

GoString returns the string representation

func (*GetPolicyOutput) SetPolicy Uses

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

SetPolicy sets the Policy field's value.

func (*GetPolicyOutput) SetPolicyArn Uses

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

SetPolicyArn sets the PolicyArn field's value.

func (GetPolicyOutput) String Uses

func (s GetPolicyOutput) String() string

String returns the string representation

type GetProtectionStatusInput Uses

type GetProtectionStatusInput struct {

    // The end of the time period to query for the attacks. This is a timestamp
    // type. The sample request above 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 that allows you to list 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 sample request above 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 Uses

func (s GetProtectionStatusInput) GoString() string

GoString returns the string representation

func (*GetProtectionStatusInput) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*GetProtectionStatusInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*GetProtectionStatusInput) SetMemberAccountId Uses

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

SetMemberAccountId sets the MemberAccountId field's value.

func (*GetProtectionStatusInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetProtectionStatusInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*GetProtectionStatusInput) SetStartTime Uses

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

SetStartTime sets the StartTime field's value.

func (GetProtectionStatusInput) String Uses

func (s GetProtectionStatusInput) String() string

String returns the string representation

func (*GetProtectionStatusInput) Validate Uses

func (s *GetProtectionStatusInput) Validate() error

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

type GetProtectionStatusOutput Uses

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. An example is shown in the Examples section
    // below.
    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 Uses

func (s GetProtectionStatusOutput) GoString() string

GoString returns the string representation

func (*GetProtectionStatusOutput) SetAdminAccountId Uses

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

SetAdminAccountId sets the AdminAccountId field's value.

func (*GetProtectionStatusOutput) SetData Uses

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

SetData sets the Data field's value.

func (*GetProtectionStatusOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*GetProtectionStatusOutput) SetServiceType Uses

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

SetServiceType sets the ServiceType field's value.

func (GetProtectionStatusOutput) String Uses

func (s GetProtectionStatusOutput) String() string

String returns the string representation

type ListComplianceStatusInput Uses

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 Uses

func (s ListComplianceStatusInput) GoString() string

GoString returns the string representation

func (*ListComplianceStatusInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListComplianceStatusInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListComplianceStatusInput) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (ListComplianceStatusInput) String Uses

func (s ListComplianceStatusInput) String() string

String returns the string representation

func (*ListComplianceStatusInput) Validate Uses

func (s *ListComplianceStatusInput) Validate() error

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

type ListComplianceStatusOutput Uses

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 Uses

func (s ListComplianceStatusOutput) GoString() string

GoString returns the string representation

func (*ListComplianceStatusOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListComplianceStatusOutput) SetPolicyComplianceStatusList Uses

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

SetPolicyComplianceStatusList sets the PolicyComplianceStatusList field's value.

func (ListComplianceStatusOutput) String Uses

func (s ListComplianceStatusOutput) String() string

String returns the string representation

type ListMemberAccountsInput Uses

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 Uses

func (s ListMemberAccountsInput) GoString() string

GoString returns the string representation

func (*ListMemberAccountsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListMemberAccountsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListMemberAccountsInput) String Uses

func (s ListMemberAccountsInput) String() string

String returns the string representation

func (*ListMemberAccountsInput) Validate Uses

func (s *ListMemberAccountsInput) Validate() error

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

type ListMemberAccountsOutput Uses

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 Uses

func (s ListMemberAccountsOutput) GoString() string

GoString returns the string representation

func (*ListMemberAccountsOutput) SetMemberAccounts Uses

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

SetMemberAccounts sets the MemberAccounts field's value.

func (*ListMemberAccountsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListMemberAccountsOutput) String Uses

func (s ListMemberAccountsOutput) String() string

String returns the string representation

type ListPoliciesInput Uses

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 Uses

func (s ListPoliciesInput) GoString() string

GoString returns the string representation

func (*ListPoliciesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListPoliciesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListPoliciesInput) String Uses

func (s ListPoliciesInput) String() string

String returns the string representation

func (*ListPoliciesInput) Validate Uses

func (s *ListPoliciesInput) Validate() error

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

type ListPoliciesOutput Uses

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 Uses

func (s ListPoliciesOutput) GoString() string

GoString returns the string representation

func (*ListPoliciesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListPoliciesOutput) SetPolicyList Uses

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

SetPolicyList sets the PolicyList field's value.

func (ListPoliciesOutput) String Uses

func (s ListPoliciesOutput) String() string

String returns the string representation

type Policy Uses

type Policy struct {

    // Specifies the AWS account IDs to exclude from the policy. The IncludeMap
    // values are evaluated first, with all the appropriate account IDs added to
    // the policy. Then the accounts listed in ExcludeMap are removed, resulting
    // in the final list of accounts to add to the policy.
    //
    // The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT”
    // : [“accountID1”, “accountID2”]}.
    ExcludeMap map[string][]*string `type:"map"`

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

    // Specifies the AWS account IDs to include in the policy. If IncludeMap is
    // null, all accounts in the organization in AWS Organizations are included
    // in the policy. If IncludeMap is not null, only values listed in IncludeMap
    // are included in the policy.
    //
    // The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT”
    // : [“accountID1”, “accountID2”]}.
    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 to protect with the policy. This is in the format shown
    // in 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 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 Uses

func (s Policy) GoString() string

GoString returns the string representation

func (*Policy) SetExcludeMap Uses

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

SetExcludeMap sets the ExcludeMap field's value.

func (*Policy) SetExcludeResourceTags Uses

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

SetExcludeResourceTags sets the ExcludeResourceTags field's value.

func (*Policy) SetIncludeMap Uses

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

SetIncludeMap sets the IncludeMap field's value.

func (*Policy) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*Policy) SetPolicyName Uses

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

SetPolicyName sets the PolicyName field's value.

func (*Policy) SetPolicyUpdateToken Uses

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

SetPolicyUpdateToken sets the PolicyUpdateToken field's value.

func (*Policy) SetRemediationEnabled Uses

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

SetRemediationEnabled sets the RemediationEnabled field's value.

func (*Policy) SetResourceTags Uses

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

SetResourceTags sets the ResourceTags field's value.

func (*Policy) SetResourceType Uses

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

SetResourceType sets the ResourceType field's value.

func (*Policy) SetResourceTypeList Uses

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

SetResourceTypeList sets the ResourceTypeList field's value.

func (*Policy) SetSecurityServicePolicyData Uses

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

SetSecurityServicePolicyData sets the SecurityServicePolicyData field's value.

func (Policy) String Uses

func (s Policy) String() string

String returns the string representation

func (*Policy) Validate Uses

func (s *Policy) Validate() error

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

type PolicyComplianceDetail Uses

type PolicyComplianceDetail struct {

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

    // A time stamp 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 non-compliant. 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 are not protected by the policy.
    Violators []*ComplianceViolator `type:"list"`
    // contains filtered or unexported fields
}

Describes the non-compliant 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 non-compliant, EvaluationLimitExceeded is set to True.

func (PolicyComplianceDetail) GoString Uses

func (s PolicyComplianceDetail) GoString() string

GoString returns the string representation

func (*PolicyComplianceDetail) SetEvaluationLimitExceeded Uses

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

SetEvaluationLimitExceeded sets the EvaluationLimitExceeded field's value.

func (*PolicyComplianceDetail) SetExpiredAt Uses

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

SetExpiredAt sets the ExpiredAt field's value.

func (*PolicyComplianceDetail) SetIssueInfoMap Uses

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

SetIssueInfoMap sets the IssueInfoMap field's value.

func (*PolicyComplianceDetail) SetMemberAccount Uses

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

SetMemberAccount sets the MemberAccount field's value.

func (*PolicyComplianceDetail) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*PolicyComplianceDetail) SetPolicyOwner Uses

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

SetPolicyOwner sets the PolicyOwner field's value.

func (*PolicyComplianceDetail) SetViolators Uses

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

SetViolators sets the Violators field's value.

func (PolicyComplianceDetail) String Uses

func (s PolicyComplianceDetail) String() string

String returns the string representation

type PolicyComplianceStatus Uses

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 non-compliant. 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"`

    // Time stamp 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 non-compliant if it includes resources that are not protected by the policy.

func (PolicyComplianceStatus) GoString Uses

func (s PolicyComplianceStatus) GoString() string

GoString returns the string representation

func (*PolicyComplianceStatus) SetEvaluationResults Uses

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

SetEvaluationResults sets the EvaluationResults field's value.

func (*PolicyComplianceStatus) SetIssueInfoMap Uses

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

SetIssueInfoMap sets the IssueInfoMap field's value.

func (*PolicyComplianceStatus) SetLastUpdated Uses

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

SetLastUpdated sets the LastUpdated field's value.

func (*PolicyComplianceStatus) SetMemberAccount Uses

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

SetMemberAccount sets the MemberAccount field's value.

func (*PolicyComplianceStatus) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*PolicyComplianceStatus) SetPolicyName Uses

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

SetPolicyName sets the PolicyName field's value.

func (*PolicyComplianceStatus) SetPolicyOwner Uses

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

SetPolicyOwner sets the PolicyOwner field's value.

func (PolicyComplianceStatus) String Uses

func (s PolicyComplianceStatus) String() string

String returns the string representation

type PolicySummary Uses

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 to protect with the policy. This is in the format shown
    // in 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 service that the policy is using to protect the resources. This specifies
    // the type of policy that is created, either a WAF policy or Shield Advanced
    // policy.
    SecurityServiceType *string `type:"string" enum:"SecurityServiceType"`
    // contains filtered or unexported fields
}

Details of the AWS Firewall Manager policy.

func (PolicySummary) GoString Uses

func (s PolicySummary) GoString() string

GoString returns the string representation

func (*PolicySummary) SetPolicyArn Uses

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

SetPolicyArn sets the PolicyArn field's value.

func (*PolicySummary) SetPolicyId Uses

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

SetPolicyId sets the PolicyId field's value.

func (*PolicySummary) SetPolicyName Uses

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

SetPolicyName sets the PolicyName field's value.

func (*PolicySummary) SetRemediationEnabled Uses

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

SetRemediationEnabled sets the RemediationEnabled field's value.

func (*PolicySummary) SetResourceType Uses

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

SetResourceType sets the ResourceType field's value.

func (*PolicySummary) SetSecurityServiceType Uses

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

SetSecurityServiceType sets the SecurityServiceType field's value.

func (PolicySummary) String Uses

func (s PolicySummary) String() string

String returns the string representation

type PutNotificationChannelInput Uses

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 Uses

func (s PutNotificationChannelInput) GoString() string

GoString returns the string representation

func (*PutNotificationChannelInput) SetSnsRoleName Uses

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

SetSnsRoleName sets the SnsRoleName field's value.

func (*PutNotificationChannelInput) SetSnsTopicArn Uses

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

SetSnsTopicArn sets the SnsTopicArn field's value.

func (PutNotificationChannelInput) String Uses

func (s PutNotificationChannelInput) String() string

String returns the string representation

func (*PutNotificationChannelInput) Validate Uses

func (s *PutNotificationChannelInput) Validate() error

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

type PutNotificationChannelOutput Uses

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

func (PutNotificationChannelOutput) GoString Uses

func (s PutNotificationChannelOutput) GoString() string

GoString returns the string representation

func (PutNotificationChannelOutput) String Uses

func (s PutNotificationChannelOutput) String() string

String returns the string representation

type PutPolicyInput Uses

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"`
    // contains filtered or unexported fields
}

func (PutPolicyInput) GoString Uses

func (s PutPolicyInput) GoString() string

GoString returns the string representation

func (*PutPolicyInput) SetPolicy Uses

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

SetPolicy sets the Policy field's value.

func (PutPolicyInput) String Uses

func (s PutPolicyInput) String() string

String returns the string representation

func (*PutPolicyInput) Validate Uses

func (s *PutPolicyInput) Validate() error

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

type PutPolicyOutput Uses

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 Uses

func (s PutPolicyOutput) GoString() string

GoString returns the string representation

func (*PutPolicyOutput) SetPolicy Uses

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

SetPolicy sets the Policy field's value.

func (*PutPolicyOutput) SetPolicyArn Uses

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

SetPolicyArn sets the PolicyArn field's value.

func (PutPolicyOutput) String Uses

func (s PutPolicyOutput) String() string

String returns the string representation

type ResourceTag Uses

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 protection by 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, both of which you define. Tags are combined with an "OR." That is, if you add more than one tag, if any of the tags matches, the resource is considered a match for the include or exclude. Working with Tag Editor (https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html).

func (ResourceTag) GoString Uses

func (s ResourceTag) GoString() string

GoString returns the string representation

func (*ResourceTag) SetKey Uses

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

SetKey sets the Key field's value.

func (*ResourceTag) SetValue Uses

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

SetValue sets the Value field's value.

func (ResourceTag) String Uses

func (s ResourceTag) String() string

String returns the string representation

func (*ResourceTag) Validate Uses

func (s *ResourceTag) Validate() error

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

type SecurityServicePolicyData Uses

type SecurityServicePolicyData struct {

    // Details about the service. This contains WAF data in JSON format, as shown
    // in the following example:
    //
    // ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\",
    // \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\":
    // \"BLOCK\"}}
    //
    // If this is a Shield Advanced policy, this string will be empty.
    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 a WAF policy or Shield Advanced
    // policy.
    //
    // 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 Uses

func (s SecurityServicePolicyData) GoString() string

GoString returns the string representation

func (*SecurityServicePolicyData) SetManagedServiceData Uses

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

SetManagedServiceData sets the ManagedServiceData field's value.

func (*SecurityServicePolicyData) SetType Uses

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

SetType sets the Type field's value.

func (SecurityServicePolicyData) String Uses

func (s SecurityServicePolicyData) String() string

String returns the string representation

func (*SecurityServicePolicyData) Validate Uses

func (s *SecurityServicePolicyData) Validate() error

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

Directories

PathSynopsis
fmsifacePackage fmsiface provides an interface to enable mocking the Firewall Management Service service client for testing your code.

Package fms imports 10 packages (graph) and is imported by 12 packages. Updated 2019-06-03. Refresh now. Tools for package owners.