fms

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2019 License: Apache-2.0 Imports: 8 Imported by: 12

Documentation

Overview

Package fms provides the client and types for making API requests to FMS.

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 use FMS 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 FMS client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/fms/#New

Index

Constants

View Source 
const (
	ServiceName = "FMS" // Service's name
	ServiceID   = "FMS" // Service's identifier
	EndpointsID = "fms" // Service's Endpoint identifier
)
View Source 
const (

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

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

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

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

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

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountRoleStatus added in v0.5.0 

type AccountRoleStatus string
const (
	AccountRoleStatusReady           AccountRoleStatus = "READY"
	AccountRoleStatusCreating        AccountRoleStatus = "CREATING"
	AccountRoleStatusPendingDeletion AccountRoleStatus = "PENDING_DELETION"
	AccountRoleStatusDeleting        AccountRoleStatus = "DELETING"
	AccountRoleStatusDeleted         AccountRoleStatus = "DELETED"
)

Enum values for AccountRoleStatus

func (AccountRoleStatus) MarshalValue added in v0.5.0 

func (enum AccountRoleStatus) MarshalValue() (string, error)

func (AccountRoleStatus) MarshalValueBuf added in v0.5.0 

func (enum AccountRoleStatus) MarshalValueBuf(b []byte) ([]byte, error)

type AssociateAdminAccountInput 

type AssociateAdminAccountInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccountRequest

func (AssociateAdminAccountInput) String 

func (s AssociateAdminAccountInput) String() string

String returns the string representation

func (*AssociateAdminAccountInput) Validate 

func (s *AssociateAdminAccountInput) Validate() error

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

type AssociateAdminAccountOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/AssociateAdminAccountOutput

func (AssociateAdminAccountOutput) String 

func (s AssociateAdminAccountOutput) String() string

String returns the string representation

type AssociateAdminAccountRequest 

type AssociateAdminAccountRequest struct {
	*aws.Request
	Input *AssociateAdminAccountInput
	Copy  func(*AssociateAdminAccountInput) AssociateAdminAccountRequest
}

AssociateAdminAccountRequest is the request type for the AssociateAdminAccount API operation.

func (AssociateAdminAccountRequest) Send 

func (r AssociateAdminAccountRequest) Send(ctx context.Context) (*AssociateAdminAccountResponse, error)

Send marshals and sends the AssociateAdminAccount API request.

type AssociateAdminAccountResponse added in v0.9.0 

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

AssociateAdminAccountResponse is the response type for the AssociateAdminAccount API operation.

func (*AssociateAdminAccountResponse) SDKResponseMetdata added in v0.9.0 

func (r *AssociateAdminAccountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateAdminAccount request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := fms.New(myConfig)

func (*Client) AssociateAdminAccountRequest added in v0.9.0 

func (c *Client) AssociateAdminAccountRequest(input *AssociateAdminAccountInput) AssociateAdminAccountRequest

AssociateAdminAccountRequest returns a request value for making 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. 

// Example sending a request using AssociateAdminAccountRequest.
req := client.AssociateAdminAccountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteNotificationChannelRequest added in v0.9.0 

func (c *Client) DeleteNotificationChannelRequest(input *DeleteNotificationChannelInput) DeleteNotificationChannelRequest

DeleteNotificationChannelRequest returns a request value for making 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. 

// Example sending a request using DeleteNotificationChannelRequest.
req := client.DeleteNotificationChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeletePolicyRequest added in v0.9.0 

func (c *Client) DeletePolicyRequest(input *DeletePolicyInput) DeletePolicyRequest

DeletePolicyRequest returns a request value for making API operation for Firewall Management Service.

Permanently deletes an AWS Firewall Manager policy. 

// Example sending a request using DeletePolicyRequest.
req := client.DeletePolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DisassociateAdminAccountRequest added in v0.9.0 

func (c *Client) DisassociateAdminAccountRequest(input *DisassociateAdminAccountInput) DisassociateAdminAccountRequest

DisassociateAdminAccountRequest returns a request value for making 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 . 

// Example sending a request using DisassociateAdminAccountRequest.
req := client.DisassociateAdminAccountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetAdminAccountRequest added in v0.9.0 

func (c *Client) GetAdminAccountRequest(input *GetAdminAccountInput) GetAdminAccountRequest

GetAdminAccountRequest returns a request value for making 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. 

// Example sending a request using GetAdminAccountRequest.
req := client.GetAdminAccountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetComplianceDetailRequest added in v0.9.0 

func (c *Client) GetComplianceDetailRequest(input *GetComplianceDetailInput) GetComplianceDetailRequest

GetComplianceDetailRequest returns a request value for making 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. 

// Example sending a request using GetComplianceDetailRequest.
req := client.GetComplianceDetailRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetNotificationChannelRequest added in v0.9.0 

func (c *Client) GetNotificationChannelRequest(input *GetNotificationChannelInput) GetNotificationChannelRequest

GetNotificationChannelRequest returns a request value for making 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. 

// Example sending a request using GetNotificationChannelRequest.
req := client.GetNotificationChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetPolicyRequest added in v0.9.0 

func (c *Client) GetPolicyRequest(input *GetPolicyInput) GetPolicyRequest

GetPolicyRequest returns a request value for making API operation for Firewall Management Service.

Returns information about the specified AWS Firewall Manager policy. 

// Example sending a request using GetPolicyRequest.
req := client.GetPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetProtectionStatusRequest added in v0.9.0 

func (c *Client) GetProtectionStatusRequest(input *GetProtectionStatusInput) GetProtectionStatusRequest

GetProtectionStatusRequest returns a request value for making 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. 

// Example sending a request using GetProtectionStatusRequest.
req := client.GetProtectionStatusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListComplianceStatusRequest added in v0.9.0 

func (c *Client) ListComplianceStatusRequest(input *ListComplianceStatusInput) ListComplianceStatusRequest

ListComplianceStatusRequest returns a request value for making 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. 

// Example sending a request using ListComplianceStatusRequest.
req := client.ListComplianceStatusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListMemberAccountsRequest added in v0.9.0 

func (c *Client) ListMemberAccountsRequest(input *ListMemberAccountsInput) ListMemberAccountsRequest

ListMemberAccountsRequest returns a request value for making 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. 

// Example sending a request using ListMemberAccountsRequest.
req := client.ListMemberAccountsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListPoliciesRequest added in v0.9.0 

func (c *Client) ListPoliciesRequest(input *ListPoliciesInput) ListPoliciesRequest

ListPoliciesRequest returns a request value for making API operation for Firewall Management Service.

Returns an array of PolicySummary objects in the response. 

// Example sending a request using ListPoliciesRequest.
req := client.ListPoliciesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutNotificationChannelRequest added in v0.9.0 

func (c *Client) PutNotificationChannelRequest(input *PutNotificationChannelInput) PutNotificationChannelRequest

PutNotificationChannelRequest returns a request value for making 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. 

// Example sending a request using PutNotificationChannelRequest.
req := client.PutNotificationChannelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutPolicyRequest added in v0.9.0 

func (c *Client) PutPolicyRequest(input *PutPolicyInput) PutPolicyRequest

PutPolicyRequest returns a request value for making 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). 

// Example sending a request using PutPolicyRequest.
req := client.PutPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type ComplianceViolator 

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 ViolationReason `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Details of the resource that is not protected by the policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ComplianceViolator

func (ComplianceViolator) String 

func (s ComplianceViolator) String() string

String returns the string representation

type CustomerPolicyScopeIdType added in v0.5.0 

type CustomerPolicyScopeIdType string
const (
	CustomerPolicyScopeIdTypeAccount CustomerPolicyScopeIdType = "ACCOUNT"
)

Enum values for CustomerPolicyScopeIdType

func (CustomerPolicyScopeIdType) MarshalValue added in v0.5.0 

func (enum CustomerPolicyScopeIdType) MarshalValue() (string, error)

func (CustomerPolicyScopeIdType) MarshalValueBuf added in v0.5.0 

func (enum CustomerPolicyScopeIdType) MarshalValueBuf(b []byte) ([]byte, error)

type DeleteNotificationChannelInput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannelRequest

func (DeleteNotificationChannelInput) String 

func (s DeleteNotificationChannelInput) String() string

String returns the string representation

type DeleteNotificationChannelOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeleteNotificationChannelOutput

func (DeleteNotificationChannelOutput) String 

func (s DeleteNotificationChannelOutput) String() string

String returns the string representation

type DeleteNotificationChannelRequest 

type DeleteNotificationChannelRequest struct {
	*aws.Request
	Input *DeleteNotificationChannelInput
	Copy  func(*DeleteNotificationChannelInput) DeleteNotificationChannelRequest
}

DeleteNotificationChannelRequest is the request type for the DeleteNotificationChannel API operation.

func (DeleteNotificationChannelRequest) Send 

func (r DeleteNotificationChannelRequest) Send(ctx context.Context) (*DeleteNotificationChannelResponse, error)

Send marshals and sends the DeleteNotificationChannel API request.

type DeleteNotificationChannelResponse added in v0.9.0 

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

DeleteNotificationChannelResponse is the response type for the DeleteNotificationChannel API operation.

func (*DeleteNotificationChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteNotificationChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteNotificationChannel request.

type DeletePolicyInput 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicyRequest

func (DeletePolicyInput) String 

func (s DeletePolicyInput) String() string

String returns the string representation

func (*DeletePolicyInput) Validate 

func (s *DeletePolicyInput) Validate() error

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

type DeletePolicyOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DeletePolicyOutput

func (DeletePolicyOutput) String 

func (s DeletePolicyOutput) String() string

String returns the string representation

type DeletePolicyRequest 

type DeletePolicyRequest struct {
	*aws.Request
	Input *DeletePolicyInput
	Copy  func(*DeletePolicyInput) DeletePolicyRequest
}

DeletePolicyRequest is the request type for the DeletePolicy API operation.

func (DeletePolicyRequest) Send 

func (r DeletePolicyRequest) Send(ctx context.Context) (*DeletePolicyResponse, error)

Send marshals and sends the DeletePolicy API request.

type DeletePolicyResponse added in v0.9.0 

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

DeletePolicyResponse is the response type for the DeletePolicy API operation.

func (*DeletePolicyResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeletePolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePolicy request.

type DependentServiceName added in v0.5.0 

type DependentServiceName string
const (
	DependentServiceNameAwsconfig         DependentServiceName = "AWSCONFIG"
	DependentServiceNameAwswaf            DependentServiceName = "AWSWAF"
	DependentServiceNameAwsshieldAdvanced DependentServiceName = "AWSSHIELD_ADVANCED"
)

Enum values for DependentServiceName

func (DependentServiceName) MarshalValue added in v0.5.0 

func (enum DependentServiceName) MarshalValue() (string, error)

func (DependentServiceName) MarshalValueBuf added in v0.5.0 

func (enum DependentServiceName) MarshalValueBuf(b []byte) ([]byte, error)

type DisassociateAdminAccountInput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccountRequest

func (DisassociateAdminAccountInput) String 

func (s DisassociateAdminAccountInput) String() string

String returns the string representation

type DisassociateAdminAccountOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/DisassociateAdminAccountOutput

func (DisassociateAdminAccountOutput) String 

func (s DisassociateAdminAccountOutput) String() string

String returns the string representation

type DisassociateAdminAccountRequest 

type DisassociateAdminAccountRequest struct {
	*aws.Request
	Input *DisassociateAdminAccountInput
	Copy  func(*DisassociateAdminAccountInput) DisassociateAdminAccountRequest
}

DisassociateAdminAccountRequest is the request type for the DisassociateAdminAccount API operation.

func (DisassociateAdminAccountRequest) Send 

func (r DisassociateAdminAccountRequest) Send(ctx context.Context) (*DisassociateAdminAccountResponse, error)

Send marshals and sends the DisassociateAdminAccount API request.

type DisassociateAdminAccountResponse added in v0.9.0 

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

DisassociateAdminAccountResponse is the response type for the DisassociateAdminAccount API operation.

func (*DisassociateAdminAccountResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisassociateAdminAccountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateAdminAccount request.

type EvaluationResult 

type EvaluationResult struct {

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/EvaluationResult

func (EvaluationResult) String 

func (s EvaluationResult) String() string

String returns the string representation

type GetAdminAccountInput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccountRequest

func (GetAdminAccountInput) String 

func (s GetAdminAccountInput) String() string

String returns the string representation

type GetAdminAccountOutput 

type GetAdminAccountOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetAdminAccountResponse

func (GetAdminAccountOutput) String 

func (s GetAdminAccountOutput) String() string

String returns the string representation

type GetAdminAccountRequest 

type GetAdminAccountRequest struct {
	*aws.Request
	Input *GetAdminAccountInput
	Copy  func(*GetAdminAccountInput) GetAdminAccountRequest
}

GetAdminAccountRequest is the request type for the GetAdminAccount API operation.

func (GetAdminAccountRequest) Send 

func (r GetAdminAccountRequest) Send(ctx context.Context) (*GetAdminAccountResponse, error)

Send marshals and sends the GetAdminAccount API request.

type GetAdminAccountResponse added in v0.9.0 

type GetAdminAccountResponse struct {
	*GetAdminAccountOutput
	// contains filtered or unexported fields
}

GetAdminAccountResponse is the response type for the GetAdminAccount API operation.

func (*GetAdminAccountResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetAdminAccountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetAdminAccount request.

type GetComplianceDetailInput 

type GetComplianceDetailInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetailRequest

func (GetComplianceDetailInput) String 

func (s GetComplianceDetailInput) String() string

String returns the string representation

func (*GetComplianceDetailInput) Validate 

func (s *GetComplianceDetailInput) Validate() error

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

type GetComplianceDetailOutput 

type GetComplianceDetailOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetComplianceDetailResponse

func (GetComplianceDetailOutput) String 

func (s GetComplianceDetailOutput) String() string

String returns the string representation

type GetComplianceDetailRequest 

type GetComplianceDetailRequest struct {
	*aws.Request
	Input *GetComplianceDetailInput
	Copy  func(*GetComplianceDetailInput) GetComplianceDetailRequest
}

GetComplianceDetailRequest is the request type for the GetComplianceDetail API operation.

func (GetComplianceDetailRequest) Send 

func (r GetComplianceDetailRequest) Send(ctx context.Context) (*GetComplianceDetailResponse, error)

Send marshals and sends the GetComplianceDetail API request.

type GetComplianceDetailResponse added in v0.9.0 

type GetComplianceDetailResponse struct {
	*GetComplianceDetailOutput
	// contains filtered or unexported fields
}

GetComplianceDetailResponse is the response type for the GetComplianceDetail API operation.

func (*GetComplianceDetailResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetComplianceDetailResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetComplianceDetail request.

type GetNotificationChannelInput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannelRequest

func (GetNotificationChannelInput) String 

func (s GetNotificationChannelInput) String() string

String returns the string representation

type GetNotificationChannelOutput 

type GetNotificationChannelOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetNotificationChannelResponse

func (GetNotificationChannelOutput) String 

func (s GetNotificationChannelOutput) String() string

String returns the string representation

type GetNotificationChannelRequest 

type GetNotificationChannelRequest struct {
	*aws.Request
	Input *GetNotificationChannelInput
	Copy  func(*GetNotificationChannelInput) GetNotificationChannelRequest
}

GetNotificationChannelRequest is the request type for the GetNotificationChannel API operation.

func (GetNotificationChannelRequest) Send 

func (r GetNotificationChannelRequest) Send(ctx context.Context) (*GetNotificationChannelResponse, error)

Send marshals and sends the GetNotificationChannel API request.

type GetNotificationChannelResponse added in v0.9.0 

type GetNotificationChannelResponse struct {
	*GetNotificationChannelOutput
	// contains filtered or unexported fields
}

GetNotificationChannelResponse is the response type for the GetNotificationChannel API operation.

func (*GetNotificationChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetNotificationChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetNotificationChannel request.

type GetPolicyInput 

type GetPolicyInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicyRequest

func (GetPolicyInput) String 

func (s GetPolicyInput) String() string

String returns the string representation

func (*GetPolicyInput) Validate 

func (s *GetPolicyInput) Validate() error

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

type GetPolicyOutput 

type GetPolicyOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetPolicyResponse

func (GetPolicyOutput) String 

func (s GetPolicyOutput) String() string

String returns the string representation

type GetPolicyRequest 

type GetPolicyRequest struct {
	*aws.Request
	Input *GetPolicyInput
	Copy  func(*GetPolicyInput) GetPolicyRequest
}

GetPolicyRequest is the request type for the GetPolicy API operation.

func (GetPolicyRequest) Send 

func (r GetPolicyRequest) Send(ctx context.Context) (*GetPolicyResponse, error)

Send marshals and sends the GetPolicy API request.

type GetPolicyResponse added in v0.9.0 

type GetPolicyResponse struct {
	*GetPolicyOutput
	// contains filtered or unexported fields
}

GetPolicyResponse is the response type for the GetPolicy API operation.

func (*GetPolicyResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetPolicy request.

type GetProtectionStatusInput added in v0.8.0 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetProtectionStatusRequest

func (GetProtectionStatusInput) String added in v0.8.0 

func (s GetProtectionStatusInput) String() string

String returns the string representation

func (*GetProtectionStatusInput) Validate added in v0.8.0 

func (s *GetProtectionStatusInput) Validate() error

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

type GetProtectionStatusOutput added in v0.8.0 

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 SecurityServiceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/GetProtectionStatusResponse

func (GetProtectionStatusOutput) String added in v0.8.0 

func (s GetProtectionStatusOutput) String() string

String returns the string representation

type GetProtectionStatusRequest added in v0.8.0 

type GetProtectionStatusRequest struct {
	*aws.Request
	Input *GetProtectionStatusInput
	Copy  func(*GetProtectionStatusInput) GetProtectionStatusRequest
}

GetProtectionStatusRequest is the request type for the GetProtectionStatus API operation.

func (GetProtectionStatusRequest) Send added in v0.8.0 

func (r GetProtectionStatusRequest) Send(ctx context.Context) (*GetProtectionStatusResponse, error)

Send marshals and sends the GetProtectionStatus API request.

type GetProtectionStatusResponse added in v0.9.0 

type GetProtectionStatusResponse struct {
	*GetProtectionStatusOutput
	// contains filtered or unexported fields
}

GetProtectionStatusResponse is the response type for the GetProtectionStatus API operation.

func (*GetProtectionStatusResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetProtectionStatusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetProtectionStatus request.

type ListComplianceStatusInput 

type ListComplianceStatusInput struct {

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatusRequest

func (ListComplianceStatusInput) String 

func (s ListComplianceStatusInput) String() string

String returns the string representation

func (*ListComplianceStatusInput) Validate 

func (s *ListComplianceStatusInput) Validate() error

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

type ListComplianceStatusOutput 

type ListComplianceStatusOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListComplianceStatusResponse

func (ListComplianceStatusOutput) String 

func (s ListComplianceStatusOutput) String() string

String returns the string representation

type ListComplianceStatusPaginator added in v0.9.0 

type ListComplianceStatusPaginator struct {
	aws.Pager
}

ListComplianceStatusPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListComplianceStatusPaginator added in v0.9.0 

func NewListComplianceStatusPaginator(req ListComplianceStatusRequest) ListComplianceStatusPaginator

NewListComplianceStatusRequestPaginator returns a paginator for ListComplianceStatus. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListComplianceStatusRequest(input)
p := fms.NewListComplianceStatusRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListComplianceStatusPaginator) CurrentPage added in v0.9.0 

func (p *ListComplianceStatusPaginator) CurrentPage() *ListComplianceStatusOutput

type ListComplianceStatusRequest 

type ListComplianceStatusRequest struct {
	*aws.Request
	Input *ListComplianceStatusInput
	Copy  func(*ListComplianceStatusInput) ListComplianceStatusRequest
}

ListComplianceStatusRequest is the request type for the ListComplianceStatus API operation.

func (ListComplianceStatusRequest) Send 

func (r ListComplianceStatusRequest) Send(ctx context.Context) (*ListComplianceStatusResponse, error)

Send marshals and sends the ListComplianceStatus API request.

type ListComplianceStatusResponse added in v0.9.0 

type ListComplianceStatusResponse struct {
	*ListComplianceStatusOutput
	// contains filtered or unexported fields
}

ListComplianceStatusResponse is the response type for the ListComplianceStatus API operation.

func (*ListComplianceStatusResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListComplianceStatusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListComplianceStatus request.

type ListMemberAccountsInput added in v0.5.0 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListMemberAccountsRequest

func (ListMemberAccountsInput) String added in v0.5.0 

func (s ListMemberAccountsInput) String() string

String returns the string representation

func (*ListMemberAccountsInput) Validate added in v0.5.0 

func (s *ListMemberAccountsInput) Validate() error

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

type ListMemberAccountsOutput added in v0.5.0 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListMemberAccountsResponse

func (ListMemberAccountsOutput) String added in v0.5.0 

func (s ListMemberAccountsOutput) String() string

String returns the string representation

type ListMemberAccountsPaginator added in v0.9.0 

type ListMemberAccountsPaginator struct {
	aws.Pager
}

ListMemberAccountsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListMemberAccountsPaginator added in v0.9.0 

func NewListMemberAccountsPaginator(req ListMemberAccountsRequest) ListMemberAccountsPaginator

NewListMemberAccountsRequestPaginator returns a paginator for ListMemberAccounts. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListMemberAccountsRequest(input)
p := fms.NewListMemberAccountsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListMemberAccountsPaginator) CurrentPage added in v0.9.0 

func (p *ListMemberAccountsPaginator) CurrentPage() *ListMemberAccountsOutput

type ListMemberAccountsRequest added in v0.5.0 

type ListMemberAccountsRequest struct {
	*aws.Request
	Input *ListMemberAccountsInput
	Copy  func(*ListMemberAccountsInput) ListMemberAccountsRequest
}

ListMemberAccountsRequest is the request type for the ListMemberAccounts API operation.

func (ListMemberAccountsRequest) Send added in v0.5.0 

func (r ListMemberAccountsRequest) Send(ctx context.Context) (*ListMemberAccountsResponse, error)

Send marshals and sends the ListMemberAccounts API request.

type ListMemberAccountsResponse added in v0.9.0 

type ListMemberAccountsResponse struct {
	*ListMemberAccountsOutput
	// contains filtered or unexported fields
}

ListMemberAccountsResponse is the response type for the ListMemberAccounts API operation.

func (*ListMemberAccountsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListMemberAccountsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListMemberAccounts request.

type ListPoliciesInput 

type ListPoliciesInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPoliciesRequest

func (ListPoliciesInput) String 

func (s ListPoliciesInput) String() string

String returns the string representation

func (*ListPoliciesInput) Validate 

func (s *ListPoliciesInput) Validate() error

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

type ListPoliciesOutput 

type ListPoliciesOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ListPoliciesResponse

func (ListPoliciesOutput) String 

func (s ListPoliciesOutput) String() string

String returns the string representation

type ListPoliciesPaginator added in v0.9.0 

type ListPoliciesPaginator struct {
	aws.Pager
}

ListPoliciesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPoliciesPaginator added in v0.9.0 

func NewListPoliciesPaginator(req ListPoliciesRequest) ListPoliciesPaginator

NewListPoliciesRequestPaginator returns a paginator for ListPolicies. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListPoliciesRequest(input)
p := fms.NewListPoliciesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPoliciesPaginator) CurrentPage added in v0.9.0 

func (p *ListPoliciesPaginator) CurrentPage() *ListPoliciesOutput

type ListPoliciesRequest 

type ListPoliciesRequest struct {
	*aws.Request
	Input *ListPoliciesInput
	Copy  func(*ListPoliciesInput) ListPoliciesRequest
}

ListPoliciesRequest is the request type for the ListPolicies API operation.

func (ListPoliciesRequest) Send 

func (r ListPoliciesRequest) Send(ctx context.Context) (*ListPoliciesResponse, error)

Send marshals and sends the ListPolicies API request.

type ListPoliciesResponse added in v0.9.0 

type ListPoliciesResponse struct {
	*ListPoliciesOutput
	// contains filtered or unexported fields
}

ListPoliciesResponse is the response type for the ListPolicies API operation.

func (*ListPoliciesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListPoliciesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPolicies request.

type Policy 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/Policy

func (Policy) String 

func (s Policy) String() string

String returns the string representation

func (*Policy) Validate 

func (s *Policy) Validate() error

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

type PolicyComplianceDetail 

type PolicyComplianceDetail struct {

	// Indicates if over 100 resources are 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PolicyComplianceDetail

func (PolicyComplianceDetail) String 

func (s PolicyComplianceDetail) String() string

String returns the string representation

type PolicyComplianceStatus 

type PolicyComplianceStatus struct {

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

	// Details about problems with dependent services, such as AWS WAF or AWS Config,
	// that are causing a resource to be 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PolicyComplianceStatus

func (PolicyComplianceStatus) String 

func (s PolicyComplianceStatus) String() string

String returns the string representation

type PolicyComplianceStatusType 

type PolicyComplianceStatusType string
const (
	PolicyComplianceStatusTypeCompliant    PolicyComplianceStatusType = "COMPLIANT"
	PolicyComplianceStatusTypeNonCompliant PolicyComplianceStatusType = "NON_COMPLIANT"
)

Enum values for PolicyComplianceStatusType

func (PolicyComplianceStatusType) MarshalValue 

func (enum PolicyComplianceStatusType) MarshalValue() (string, error)

func (PolicyComplianceStatusType) MarshalValueBuf 

func (enum PolicyComplianceStatusType) MarshalValueBuf(b []byte) ([]byte, error)

type PolicySummary 

type PolicySummary struct {

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

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

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

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

	// The type of resource 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 SecurityServiceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Details of the AWS Firewall Manager policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PolicySummary

func (PolicySummary) String 

func (s PolicySummary) String() string

String returns the string representation

type PutNotificationChannelInput 

type PutNotificationChannelInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannelRequest

func (PutNotificationChannelInput) String 

func (s PutNotificationChannelInput) String() string

String returns the string representation

func (*PutNotificationChannelInput) Validate 

func (s *PutNotificationChannelInput) Validate() error

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

type PutNotificationChannelOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutNotificationChannelOutput

func (PutNotificationChannelOutput) String 

func (s PutNotificationChannelOutput) String() string

String returns the string representation

type PutNotificationChannelRequest 

type PutNotificationChannelRequest struct {
	*aws.Request
	Input *PutNotificationChannelInput
	Copy  func(*PutNotificationChannelInput) PutNotificationChannelRequest
}

PutNotificationChannelRequest is the request type for the PutNotificationChannel API operation.

func (PutNotificationChannelRequest) Send 

func (r PutNotificationChannelRequest) Send(ctx context.Context) (*PutNotificationChannelResponse, error)

Send marshals and sends the PutNotificationChannel API request.

type PutNotificationChannelResponse added in v0.9.0 

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

PutNotificationChannelResponse is the response type for the PutNotificationChannel API operation.

func (*PutNotificationChannelResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutNotificationChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutNotificationChannel request.

type PutPolicyInput 

type PutPolicyInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicyRequest

func (PutPolicyInput) String 

func (s PutPolicyInput) String() string

String returns the string representation

func (*PutPolicyInput) Validate 

func (s *PutPolicyInput) Validate() error

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

type PutPolicyOutput 

type PutPolicyOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/PutPolicyResponse

func (PutPolicyOutput) String 

func (s PutPolicyOutput) String() string

String returns the string representation

type PutPolicyRequest 

type PutPolicyRequest struct {
	*aws.Request
	Input *PutPolicyInput
	Copy  func(*PutPolicyInput) PutPolicyRequest
}

PutPolicyRequest is the request type for the PutPolicy API operation.

func (PutPolicyRequest) Send 

func (r PutPolicyRequest) Send(ctx context.Context) (*PutPolicyResponse, error)

Send marshals and sends the PutPolicy API request.

type PutPolicyResponse added in v0.9.0 

type PutPolicyResponse struct {
	*PutPolicyOutput
	// contains filtered or unexported fields
}

PutPolicyResponse is the response type for the PutPolicy API operation.

func (*PutPolicyResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutPolicy request.

type ResourceTag 

type ResourceTag struct {

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

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

The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from 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). Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ResourceTag

func (ResourceTag) String 

func (s ResourceTag) String() string

String returns the string representation

func (*ResourceTag) Validate 

func (s *ResourceTag) Validate() error

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

type SecurityServicePolicyData 

type SecurityServicePolicyData struct {

	// Details about the service. 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 SecurityServiceType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Details about the security service that is being used to protect the resources. Please also see https://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/SecurityServicePolicyData

func (SecurityServicePolicyData) String 

func (s SecurityServicePolicyData) String() string

String returns the string representation

func (*SecurityServicePolicyData) Validate 

func (s *SecurityServicePolicyData) Validate() error

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

type SecurityServiceType 

type SecurityServiceType string
const (
	SecurityServiceTypeWaf            SecurityServiceType = "WAF"
	SecurityServiceTypeShieldAdvanced SecurityServiceType = "SHIELD_ADVANCED"
)

Enum values for SecurityServiceType

func (SecurityServiceType) MarshalValue 

func (enum SecurityServiceType) MarshalValue() (string, error)

func (SecurityServiceType) MarshalValueBuf 

func (enum SecurityServiceType) MarshalValueBuf(b []byte) ([]byte, error)

type ViolationReason 

type ViolationReason string
const (
	ViolationReasonWebAclMissingRuleGroup          ViolationReason = "WEB_ACL_MISSING_RULE_GROUP"
	ViolationReasonResourceMissingWebAcl           ViolationReason = "RESOURCE_MISSING_WEB_ACL"
	ViolationReasonResourceIncorrectWebAcl         ViolationReason = "RESOURCE_INCORRECT_WEB_ACL"
	ViolationReasonResourceMissingShieldProtection ViolationReason = "RESOURCE_MISSING_SHIELD_PROTECTION"
)

Enum values for ViolationReason

func (ViolationReason) MarshalValue 

func (enum ViolationReason) MarshalValue() (string, error)

func (ViolationReason) MarshalValueBuf 

func (enum ViolationReason) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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