package securityhub
import "github.com/aws/aws-sdk-go-v2/service/securityhub"
Package securityhub provides the API client, operations, and parameter types for AWS SecurityHub.
Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the AWS Security Hub User Guide (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) . When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to. For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the master account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from. The following throttling limits apply to using Security Hub API operations.
* BatchEnableStandards - RateLimit of 1 request per second, BurstLimit of 1 request per second.
* GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.
* UpdateFindings - RateLimit of 1 request per second. BurstLimit of 5 requests per second.
* UpdateStandardsControl - RateLimit of 1 request per second, BurstLimit of 5 requests per second.
* All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AcceptInvitationInput
- type AcceptInvitationOutput
- type BatchDisableStandardsInput
- type BatchDisableStandardsOutput
- type BatchEnableStandardsInput
- type BatchEnableStandardsOutput
- type BatchImportFindingsInput
- type BatchImportFindingsOutput
- type BatchUpdateFindingsInput
- type BatchUpdateFindingsOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AcceptInvitation(ctx context.Context, params *AcceptInvitationInput, optFns ...func(*Options)) (*AcceptInvitationOutput, error)
- func (c *Client) BatchDisableStandards(ctx context.Context, params *BatchDisableStandardsInput, optFns ...func(*Options)) (*BatchDisableStandardsOutput, error)
- func (c *Client) BatchEnableStandards(ctx context.Context, params *BatchEnableStandardsInput, optFns ...func(*Options)) (*BatchEnableStandardsOutput, error)
- func (c *Client) BatchImportFindings(ctx context.Context, params *BatchImportFindingsInput, optFns ...func(*Options)) (*BatchImportFindingsOutput, error)
- func (c *Client) BatchUpdateFindings(ctx context.Context, params *BatchUpdateFindingsInput, optFns ...func(*Options)) (*BatchUpdateFindingsOutput, error)
- func (c *Client) CreateActionTarget(ctx context.Context, params *CreateActionTargetInput, optFns ...func(*Options)) (*CreateActionTargetOutput, error)
- func (c *Client) CreateInsight(ctx context.Context, params *CreateInsightInput, optFns ...func(*Options)) (*CreateInsightOutput, error)
- func (c *Client) CreateMembers(ctx context.Context, params *CreateMembersInput, optFns ...func(*Options)) (*CreateMembersOutput, error)
- func (c *Client) DeclineInvitations(ctx context.Context, params *DeclineInvitationsInput, optFns ...func(*Options)) (*DeclineInvitationsOutput, error)
- func (c *Client) DeleteActionTarget(ctx context.Context, params *DeleteActionTargetInput, optFns ...func(*Options)) (*DeleteActionTargetOutput, error)
- func (c *Client) DeleteInsight(ctx context.Context, params *DeleteInsightInput, optFns ...func(*Options)) (*DeleteInsightOutput, error)
- func (c *Client) DeleteInvitations(ctx context.Context, params *DeleteInvitationsInput, optFns ...func(*Options)) (*DeleteInvitationsOutput, error)
- func (c *Client) DeleteMembers(ctx context.Context, params *DeleteMembersInput, optFns ...func(*Options)) (*DeleteMembersOutput, error)
- func (c *Client) DescribeActionTargets(ctx context.Context, params *DescribeActionTargetsInput, optFns ...func(*Options)) (*DescribeActionTargetsOutput, error)
- func (c *Client) DescribeHub(ctx context.Context, params *DescribeHubInput, optFns ...func(*Options)) (*DescribeHubOutput, error)
- func (c *Client) DescribeOrganizationConfiguration(ctx context.Context, params *DescribeOrganizationConfigurationInput, optFns ...func(*Options)) (*DescribeOrganizationConfigurationOutput, error)
- func (c *Client) DescribeProducts(ctx context.Context, params *DescribeProductsInput, optFns ...func(*Options)) (*DescribeProductsOutput, error)
- func (c *Client) DescribeStandards(ctx context.Context, params *DescribeStandardsInput, optFns ...func(*Options)) (*DescribeStandardsOutput, error)
- func (c *Client) DescribeStandardsControls(ctx context.Context, params *DescribeStandardsControlsInput, optFns ...func(*Options)) (*DescribeStandardsControlsOutput, error)
- func (c *Client) DisableImportFindingsForProduct(ctx context.Context, params *DisableImportFindingsForProductInput, optFns ...func(*Options)) (*DisableImportFindingsForProductOutput, error)
- func (c *Client) DisableOrganizationAdminAccount(ctx context.Context, params *DisableOrganizationAdminAccountInput, optFns ...func(*Options)) (*DisableOrganizationAdminAccountOutput, error)
- func (c *Client) DisableSecurityHub(ctx context.Context, params *DisableSecurityHubInput, optFns ...func(*Options)) (*DisableSecurityHubOutput, error)
- func (c *Client) DisassociateFromMasterAccount(ctx context.Context, params *DisassociateFromMasterAccountInput, optFns ...func(*Options)) (*DisassociateFromMasterAccountOutput, error)
- func (c *Client) DisassociateMembers(ctx context.Context, params *DisassociateMembersInput, optFns ...func(*Options)) (*DisassociateMembersOutput, error)
- func (c *Client) EnableImportFindingsForProduct(ctx context.Context, params *EnableImportFindingsForProductInput, optFns ...func(*Options)) (*EnableImportFindingsForProductOutput, error)
- func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *EnableOrganizationAdminAccountInput, optFns ...func(*Options)) (*EnableOrganizationAdminAccountOutput, error)
- func (c *Client) EnableSecurityHub(ctx context.Context, params *EnableSecurityHubInput, optFns ...func(*Options)) (*EnableSecurityHubOutput, error)
- func (c *Client) GetEnabledStandards(ctx context.Context, params *GetEnabledStandardsInput, optFns ...func(*Options)) (*GetEnabledStandardsOutput, error)
- func (c *Client) GetFindings(ctx context.Context, params *GetFindingsInput, optFns ...func(*Options)) (*GetFindingsOutput, error)
- func (c *Client) GetInsightResults(ctx context.Context, params *GetInsightResultsInput, optFns ...func(*Options)) (*GetInsightResultsOutput, error)
- func (c *Client) GetInsights(ctx context.Context, params *GetInsightsInput, optFns ...func(*Options)) (*GetInsightsOutput, error)
- func (c *Client) GetInvitationsCount(ctx context.Context, params *GetInvitationsCountInput, optFns ...func(*Options)) (*GetInvitationsCountOutput, error)
- func (c *Client) GetMasterAccount(ctx context.Context, params *GetMasterAccountInput, optFns ...func(*Options)) (*GetMasterAccountOutput, error)
- func (c *Client) GetMembers(ctx context.Context, params *GetMembersInput, optFns ...func(*Options)) (*GetMembersOutput, error)
- func (c *Client) InviteMembers(ctx context.Context, params *InviteMembersInput, optFns ...func(*Options)) (*InviteMembersOutput, error)
- func (c *Client) ListEnabledProductsForImport(ctx context.Context, params *ListEnabledProductsForImportInput, optFns ...func(*Options)) (*ListEnabledProductsForImportOutput, error)
- func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInput, optFns ...func(*Options)) (*ListInvitationsOutput, error)
- func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error)
- func (c *Client) ListOrganizationAdminAccounts(ctx context.Context, params *ListOrganizationAdminAccountsInput, optFns ...func(*Options)) (*ListOrganizationAdminAccountsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateActionTarget(ctx context.Context, params *UpdateActionTargetInput, optFns ...func(*Options)) (*UpdateActionTargetOutput, error)
- func (c *Client) UpdateFindings(ctx context.Context, params *UpdateFindingsInput, optFns ...func(*Options)) (*UpdateFindingsOutput, error)
- func (c *Client) UpdateInsight(ctx context.Context, params *UpdateInsightInput, optFns ...func(*Options)) (*UpdateInsightOutput, error)
- func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *UpdateOrganizationConfigurationInput, optFns ...func(*Options)) (*UpdateOrganizationConfigurationOutput, error)
- func (c *Client) UpdateSecurityHubConfiguration(ctx context.Context, params *UpdateSecurityHubConfigurationInput, optFns ...func(*Options)) (*UpdateSecurityHubConfigurationOutput, error)
- func (c *Client) UpdateStandardsControl(ctx context.Context, params *UpdateStandardsControlInput, optFns ...func(*Options)) (*UpdateStandardsControlOutput, error)
- type CreateActionTargetInput
- type CreateActionTargetOutput
- type CreateInsightInput
- type CreateInsightOutput
- type CreateMembersInput
- type CreateMembersOutput
- type DeclineInvitationsInput
- type DeclineInvitationsOutput
- type DeleteActionTargetInput
- type DeleteActionTargetOutput
- type DeleteInsightInput
- type DeleteInsightOutput
- type DeleteInvitationsInput
- type DeleteInvitationsOutput
- type DeleteMembersInput
- type DeleteMembersOutput
- type DescribeActionTargetsAPIClient
- type DescribeActionTargetsInput
- type DescribeActionTargetsOutput
- type DescribeActionTargetsPaginator
- func NewDescribeActionTargetsPaginator(client DescribeActionTargetsAPIClient, params *DescribeActionTargetsInput, optFns ...func(*DescribeActionTargetsPaginatorOptions)) *DescribeActionTargetsPaginator
- func (p *DescribeActionTargetsPaginator) HasMorePages() bool
- func (p *DescribeActionTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeActionTargetsOutput, error)
- type DescribeActionTargetsPaginatorOptions
- type DescribeHubInput
- type DescribeHubOutput
- type DescribeOrganizationConfigurationInput
- type DescribeOrganizationConfigurationOutput
- type DescribeProductsAPIClient
- type DescribeProductsInput
- type DescribeProductsOutput
- type DescribeProductsPaginator
- func NewDescribeProductsPaginator(client DescribeProductsAPIClient, params *DescribeProductsInput, optFns ...func(*DescribeProductsPaginatorOptions)) *DescribeProductsPaginator
- func (p *DescribeProductsPaginator) HasMorePages() bool
- func (p *DescribeProductsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeProductsOutput, error)
- type DescribeProductsPaginatorOptions
- type DescribeStandardsAPIClient
- type DescribeStandardsControlsAPIClient
- type DescribeStandardsControlsInput
- type DescribeStandardsControlsOutput
- type DescribeStandardsControlsPaginator
- func NewDescribeStandardsControlsPaginator(client DescribeStandardsControlsAPIClient, params *DescribeStandardsControlsInput, optFns ...func(*DescribeStandardsControlsPaginatorOptions)) *DescribeStandardsControlsPaginator
- func (p *DescribeStandardsControlsPaginator) HasMorePages() bool
- func (p *DescribeStandardsControlsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStandardsControlsOutput, error)
- type DescribeStandardsControlsPaginatorOptions
- type DescribeStandardsInput
- type DescribeStandardsOutput
- type DescribeStandardsPaginator
- func NewDescribeStandardsPaginator(client DescribeStandardsAPIClient, params *DescribeStandardsInput, optFns ...func(*DescribeStandardsPaginatorOptions)) *DescribeStandardsPaginator
- func (p *DescribeStandardsPaginator) HasMorePages() bool
- func (p *DescribeStandardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStandardsOutput, error)
- type DescribeStandardsPaginatorOptions
- type DisableImportFindingsForProductInput
- type DisableImportFindingsForProductOutput
- type DisableOrganizationAdminAccountInput
- type DisableOrganizationAdminAccountOutput
- type DisableSecurityHubInput
- type DisableSecurityHubOutput
- type DisassociateFromMasterAccountInput
- type DisassociateFromMasterAccountOutput
- type DisassociateMembersInput
- type DisassociateMembersOutput
- type EnableImportFindingsForProductInput
- type EnableImportFindingsForProductOutput
- type EnableOrganizationAdminAccountInput
- type EnableOrganizationAdminAccountOutput
- type EnableSecurityHubInput
- type EnableSecurityHubOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetEnabledStandardsAPIClient
- type GetEnabledStandardsInput
- type GetEnabledStandardsOutput
- type GetEnabledStandardsPaginator
- func NewGetEnabledStandardsPaginator(client GetEnabledStandardsAPIClient, params *GetEnabledStandardsInput, optFns ...func(*GetEnabledStandardsPaginatorOptions)) *GetEnabledStandardsPaginator
- func (p *GetEnabledStandardsPaginator) HasMorePages() bool
- func (p *GetEnabledStandardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetEnabledStandardsOutput, error)
- type GetEnabledStandardsPaginatorOptions
- type GetFindingsAPIClient
- type GetFindingsInput
- type GetFindingsOutput
- type GetFindingsPaginator
- func NewGetFindingsPaginator(client GetFindingsAPIClient, params *GetFindingsInput, optFns ...func(*GetFindingsPaginatorOptions)) *GetFindingsPaginator
- func (p *GetFindingsPaginator) HasMorePages() bool
- func (p *GetFindingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFindingsOutput, error)
- type GetFindingsPaginatorOptions
- type GetInsightResultsInput
- type GetInsightResultsOutput
- type GetInsightsAPIClient
- type GetInsightsInput
- type GetInsightsOutput
- type GetInsightsPaginator
- func NewGetInsightsPaginator(client GetInsightsAPIClient, params *GetInsightsInput, optFns ...func(*GetInsightsPaginatorOptions)) *GetInsightsPaginator
- func (p *GetInsightsPaginator) HasMorePages() bool
- func (p *GetInsightsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInsightsOutput, error)
- type GetInsightsPaginatorOptions
- type GetInvitationsCountInput
- type GetInvitationsCountOutput
- type GetMasterAccountInput
- type GetMasterAccountOutput
- type GetMembersInput
- type GetMembersOutput
- type HTTPClient
- type HTTPSignerV4
- type InviteMembersInput
- type InviteMembersOutput
- type ListEnabledProductsForImportAPIClient
- type ListEnabledProductsForImportInput
- type ListEnabledProductsForImportOutput
- type ListEnabledProductsForImportPaginator
- func NewListEnabledProductsForImportPaginator(client ListEnabledProductsForImportAPIClient, params *ListEnabledProductsForImportInput, optFns ...func(*ListEnabledProductsForImportPaginatorOptions)) *ListEnabledProductsForImportPaginator
- func (p *ListEnabledProductsForImportPaginator) HasMorePages() bool
- func (p *ListEnabledProductsForImportPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnabledProductsForImportOutput, error)
- type ListEnabledProductsForImportPaginatorOptions
- type ListInvitationsAPIClient
- type ListInvitationsInput
- type ListInvitationsOutput
- type ListInvitationsPaginator
- func NewListInvitationsPaginator(client ListInvitationsAPIClient, params *ListInvitationsInput, optFns ...func(*ListInvitationsPaginatorOptions)) *ListInvitationsPaginator
- func (p *ListInvitationsPaginator) HasMorePages() bool
- func (p *ListInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInvitationsOutput, error)
- type ListInvitationsPaginatorOptions
- type ListMembersAPIClient
- type ListMembersInput
- type ListMembersOutput
- type ListMembersPaginator
- func NewListMembersPaginator(client ListMembersAPIClient, params *ListMembersInput, optFns ...func(*ListMembersPaginatorOptions)) *ListMembersPaginator
- func (p *ListMembersPaginator) HasMorePages() bool
- func (p *ListMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMembersOutput, error)
- type ListMembersPaginatorOptions
- type ListOrganizationAdminAccountsAPIClient
- type ListOrganizationAdminAccountsInput
- type ListOrganizationAdminAccountsOutput
- type ListOrganizationAdminAccountsPaginator
- func NewListOrganizationAdminAccountsPaginator(client ListOrganizationAdminAccountsAPIClient, params *ListOrganizationAdminAccountsInput, optFns ...func(*ListOrganizationAdminAccountsPaginatorOptions)) *ListOrganizationAdminAccountsPaginator
- func (p *ListOrganizationAdminAccountsPaginator) HasMorePages() bool
- func (p *ListOrganizationAdminAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationAdminAccountsOutput, error)
- type ListOrganizationAdminAccountsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateActionTargetInput
- type UpdateActionTargetOutput
- type UpdateFindingsInput
- type UpdateFindingsOutput
- type UpdateInsightInput
- type UpdateInsightOutput
- type UpdateOrganizationConfigurationInput
- type UpdateOrganizationConfigurationOutput
- type UpdateSecurityHubConfigurationInput
- type UpdateSecurityHubConfigurationOutput
- type UpdateStandardsControlInput
- type UpdateStandardsControlOutput
Constants ¶
const ServiceAPIVersion = "2018-10-26"
const ServiceID = "SecurityHub"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AcceptInvitationInput ¶
type AcceptInvitationInput struct { // The ID of the invitation sent from the Security Hub master account. // // This member is required. InvitationId *string // The account ID of the Security Hub master account that sent the invitation. // // This member is required. MasterId *string }
type AcceptInvitationOutput ¶
type AcceptInvitationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchDisableStandardsInput ¶
type BatchDisableStandardsInput struct { // The ARNs of the standards subscriptions to disable. // // This member is required. StandardsSubscriptionArns []string }
type BatchDisableStandardsOutput ¶
type BatchDisableStandardsOutput struct { // The details of the standards subscriptions that were disabled. StandardsSubscriptions []types.StandardsSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchEnableStandardsInput ¶
type BatchEnableStandardsInput struct { // The list of standards checks to enable. // // This member is required. StandardsSubscriptionRequests []types.StandardsSubscriptionRequest }
type BatchEnableStandardsOutput ¶
type BatchEnableStandardsOutput struct { // The details of the standards subscriptions that were enabled. StandardsSubscriptions []types.StandardsSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchImportFindingsInput ¶
type BatchImportFindingsInput struct { // A list of findings to import. To successfully import a finding, it must follow // the AWS Security Finding Format // (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html). // Maximum of 100 findings per request. // // This member is required. Findings []types.AwsSecurityFinding }
type BatchImportFindingsOutput ¶
type BatchImportFindingsOutput struct { // The number of findings that failed to import. // // This member is required. FailedCount int32 // The number of findings that were successfully imported. // // This member is required. SuccessCount int32 // The list of findings that failed to import. FailedFindings []types.ImportFindingsError // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchUpdateFindingsInput ¶
type BatchUpdateFindingsInput struct { // The list of findings to update. BatchUpdateFindings can be used to update up to // 100 findings at a time. For each finding, the list provides the finding // identifier and the ARN of the finding provider. // // This member is required. FindingIdentifiers []types.AwsSecurityFindingIdentifier // The updated value for the finding confidence. Confidence is defined as the // likelihood that a finding accurately identifies the behavior or issue that it // was intended to identify. Confidence is scored on a 0-100 basis using a ratio // scale, where 0 means zero percent confidence and 100 means 100 percent // confidence. Confidence int32 // The updated value for the level of importance assigned to the resources // associated with the findings. A score of 0 means that the underlying resources // have no criticality, and a score of 100 is reserved for the most critical // resources. Criticality int32 // The updated note. Note *types.NoteUpdate // A list of findings that are related to the updated findings. RelatedFindings []types.RelatedFinding // Used to update the finding severity. Severity *types.SeverityUpdate // One or more finding types in the format of namespace/category/classifier that // classify a finding. Valid namespace values are as follows. // // * Software and // Configuration Checks // // * TTPs // // * Effects // // * Unusual Behaviors // // * Sensitive Data // Identifications Types []string // A list of name/value string pairs associated with the finding. These are custom, // user-defined fields added to a finding. UserDefinedFields map[string]string // Indicates the veracity of a finding. The available values for VerificationState // are as follows. // // * UNKNOWN – The default disposition of a security finding // // * // TRUE_POSITIVE – The security finding is confirmed // // * FALSE_POSITIVE – The // security finding was determined to be a false alarm // // * BENIGN_POSITIVE – A // special case of TRUE_POSITIVE where the finding doesn't pose any threat, is // expected, or both VerificationState types.VerificationState // Used to update the workflow status of a finding. The workflow status indicates // the progress of the investigation into the finding. Workflow *types.WorkflowUpdate }
type BatchUpdateFindingsOutput ¶
type BatchUpdateFindingsOutput struct { // The list of findings that were updated successfully. // // This member is required. ProcessedFindings []types.AwsSecurityFindingIdentifier // The list of findings that were not updated. // // This member is required. UnprocessedFindings []types.BatchUpdateFindingsUnprocessedFinding // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS SecurityHub.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AcceptInvitation ¶
func (c *Client) AcceptInvitation(ctx context.Context, params *AcceptInvitationInput, optFns ...func(*Options)) (*AcceptInvitationOutput, error)
Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.
func (*Client) BatchDisableStandards ¶
func (c *Client) BatchDisableStandards(ctx context.Context, params *BatchDisableStandardsInput, optFns ...func(*Options)) (*BatchDisableStandardsOutput, error)
Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the AWS Security Hub User Guide.
func (*Client) BatchEnableStandards ¶
func (c *Client) BatchEnableStandards(ctx context.Context, params *BatchEnableStandardsInput, optFns ...func(*Options)) (*BatchEnableStandardsOutput, error)
Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation. For more information, see the Security Standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html) section of the AWS Security Hub User Guide.
func (*Client) BatchImportFindings ¶
func (c *Client) BatchImportFindings(ctx context.Context, params *BatchImportFindingsInput, optFns ...func(*Options)) (*BatchImportFindingsOutput, error)
Imports security findings generated from an integrated product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb. After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.
* Note
* UserDefinedFields
* VerificationState
* Workflow
Finding providers also should not use BatchImportFindings to update the following attributes.
* Confidence
* Criticality
* RelatedFindings
* Severity
* Types
Instead, finding providers use FindingProviderFields to provide values for these attributes.
func (*Client) BatchUpdateFindings ¶
func (c *Client) BatchUpdateFindings(ctx context.Context, params *BatchUpdateFindingsInput, optFns ...func(*Options)) (*BatchUpdateFindingsOutput, error)
Used by Security Hub customers to update information about their investigation into a finding. Requested by master accounts or member accounts. Master accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding. Master and member accounts can use BatchUpdateFindings to update the following finding fields and objects.
* Confidence
* Criticality
* Note
* RelatedFindings
* Severity
* Types
* UserDefinedFields
* VerificationState
* Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access) in the AWS Security Hub User Guide.
func (*Client) CreateActionTarget ¶
func (c *Client) CreateActionTarget(ctx context.Context, params *CreateActionTargetInput, optFns ...func(*Options)) (*CreateActionTargetOutput, error)
Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
func (*Client) CreateInsight ¶
func (c *Client) CreateInsight(ctx context.Context, params *CreateInsightInput, optFns ...func(*Options)) (*CreateInsightOutput, error)
Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. To group the related findings in the insight, use the GroupByAttribute.
func (*Client) CreateMembers ¶
func (c *Client) CreateMembers(ctx context.Context, params *CreateMembersInput, optFns ...func(*Options)) (*CreateMembersOutput, error)
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. If you are integrated with Organizations, then the master account is the Security Hub administrator account that is designated by the organization management account. CreateMembers is always used to add accounts that are not organization members. For accounts that are part of an organization, CreateMembers is only used in the following cases:
* Security Hub is not configured to automatically add new accounts in an organization.
* The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation. For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub. Accounts that are part of an organization do not receive an invitation. They automatically become a member account in Security Hub. A permissions policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in a member account, findings are sent to both the member and master accounts. To remove the association between the master and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
func (*Client) DeclineInvitations ¶
func (c *Client) DeclineInvitations(ctx context.Context, params *DeclineInvitationsInput, optFns ...func(*Options)) (*DeclineInvitationsOutput, error)
Declines invitations to become a member account. This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.
func (*Client) DeleteActionTarget ¶
func (c *Client) DeleteActionTarget(ctx context.Context, params *DeleteActionTargetInput, optFns ...func(*Options)) (*DeleteActionTargetOutput, error)
Deletes a custom action target from Security Hub. Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
func (*Client) DeleteInsight ¶
func (c *Client) DeleteInsight(ctx context.Context, params *DeleteInsightInput, optFns ...func(*Options)) (*DeleteInsightOutput, error)
Deletes the insight specified by the InsightArn.
func (*Client) DeleteInvitations ¶
func (c *Client) DeleteInvitations(ctx context.Context, params *DeleteInvitationsInput, optFns ...func(*Options)) (*DeleteInvitationsOutput, error)
Deletes invitations received by the AWS account to become a member account. This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.
func (*Client) DeleteMembers ¶
func (c *Client) DeleteMembers(ctx context.Context, params *DeleteMembersInput, optFns ...func(*Options)) (*DeleteMembersOutput, error)
Deletes the specified member accounts from Security Hub. Can be used to delete member accounts that belong to an organization as well as member accounts that were invited manually.
func (*Client) DescribeActionTargets ¶
func (c *Client) DescribeActionTargets(ctx context.Context, params *DescribeActionTargetsInput, optFns ...func(*Options)) (*DescribeActionTargetsOutput, error)
Returns a list of the custom action targets in Security Hub in your account.
func (*Client) DescribeHub ¶
func (c *Client) DescribeHub(ctx context.Context, params *DescribeHubInput, optFns ...func(*Options)) (*DescribeHubOutput, error)
Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.
func (*Client) DescribeOrganizationConfiguration ¶
func (c *Client) DescribeOrganizationConfiguration(ctx context.Context, params *DescribeOrganizationConfigurationInput, optFns ...func(*Options)) (*DescribeOrganizationConfigurationOutput, error)
Returns information about the Organizations configuration for Security Hub. Can only be called from a Security Hub administrator account.
func (*Client) DescribeProducts ¶
func (c *Client) DescribeProducts(ctx context.Context, params *DescribeProductsInput, optFns ...func(*Options)) (*DescribeProductsOutput, error)
Returns information about product integrations in Security Hub. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you do not provide an integration ARN, then the results include all of the available product integrations.
func (*Client) DescribeStandards ¶
func (c *Client) DescribeStandards(ctx context.Context, params *DescribeStandardsInput, optFns ...func(*Options)) (*DescribeStandardsOutput, error)
Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description.
func (*Client) DescribeStandardsControls ¶
func (c *Client) DescribeStandardsControls(ctx context.Context, params *DescribeStandardsControlsInput, optFns ...func(*Options)) (*DescribeStandardsControlsOutput, error)
Returns a list of security standards controls. For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.
func (*Client) DisableImportFindingsForProduct ¶
func (c *Client) DisableImportFindingsForProduct(ctx context.Context, params *DisableImportFindingsForProductInput, optFns ...func(*Options)) (*DisableImportFindingsForProductOutput, error)
Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.
func (*Client) DisableOrganizationAdminAccount ¶
func (c *Client) DisableOrganizationAdminAccount(ctx context.Context, params *DisableOrganizationAdminAccountInput, optFns ...func(*Options)) (*DisableOrganizationAdminAccountOutput, error)
Disables a Security Hub administrator account. Can only be called by the organization management account.
func (*Client) DisableSecurityHub ¶
func (c *Client) DisableSecurityHub(ctx context.Context, params *DisableSecurityHubInput, optFns ...func(*Options)) (*DisableSecurityHubOutput, error)
Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts. When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.
func (*Client) DisassociateFromMasterAccount ¶
func (c *Client) DisassociateFromMasterAccount(ctx context.Context, params *DisassociateFromMasterAccountInput, optFns ...func(*Options)) (*DisassociateFromMasterAccountOutput, error)
Disassociates the current Security Hub member account from the associated master account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the master account (the designated Security Hub administrator) can disassociate a member account.
func (*Client) DisassociateMembers ¶
func (c *Client) DisassociateMembers(ctx context.Context, params *DisassociateMembersInput, optFns ...func(*Options)) (*DisassociateMembersOutput, error)
Disassociates the specified member accounts from the associated master account. Can be used to disassociate both accounts that are in an organization and accounts that were invited manually.
func (*Client) EnableImportFindingsForProduct ¶
func (c *Client) EnableImportFindingsForProduct(ctx context.Context, params *EnableImportFindingsForProductInput, optFns ...func(*Options)) (*EnableImportFindingsForProductOutput, error)
Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.
func (*Client) EnableOrganizationAdminAccount ¶
func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *EnableOrganizationAdminAccountInput, optFns ...func(*Options)) (*EnableOrganizationAdminAccountOutput, error)
Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
func (*Client) EnableSecurityHub ¶
func (c *Client) EnableSecurityHub(ctx context.Context, params *EnableSecurityHubInput, optFns ...func(*Options)) (*EnableSecurityHubOutput, error)
Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub. When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards.
* CIS AWS Foundations
* AWS Foundational Security Best Practices
You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To not enable the automatically enabled standards, set EnableDefaultStandards to false. After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation. To learn more, see Setting Up AWS Security Hub (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html) in the AWS Security Hub User Guide.
func (*Client) GetEnabledStandards ¶
func (c *Client) GetEnabledStandards(ctx context.Context, params *GetEnabledStandardsInput, optFns ...func(*Options)) (*GetEnabledStandardsOutput, error)
Returns a list of the standards that are currently enabled.
func (*Client) GetFindings ¶
func (c *Client) GetFindings(ctx context.Context, params *GetFindingsInput, optFns ...func(*Options)) (*GetFindingsOutput, error)
Returns a list of findings that match the specified criteria.
func (*Client) GetInsightResults ¶
func (c *Client) GetInsightResults(ctx context.Context, params *GetInsightResultsInput, optFns ...func(*Options)) (*GetInsightResultsOutput, error)
Lists the results of the Security Hub insight specified by the insight ARN.
func (*Client) GetInsights ¶
func (c *Client) GetInsights(ctx context.Context, params *GetInsightsInput, optFns ...func(*Options)) (*GetInsightsOutput, error)
Lists and describes insights for the specified insight ARNs.
func (*Client) GetInvitationsCount ¶
func (c *Client) GetInvitationsCount(ctx context.Context, params *GetInvitationsCountInput, optFns ...func(*Options)) (*GetInvitationsCountOutput, error)
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
func (*Client) GetMasterAccount ¶
func (c *Client) GetMasterAccount(ctx context.Context, params *GetMasterAccountInput, optFns ...func(*Options)) (*GetMasterAccountOutput, error)
Provides the details for the Security Hub master account for the current member account. Can be used by both member accounts that are in an organization and accounts that were invited manually.
func (*Client) GetMembers ¶
func (c *Client) GetMembers(ctx context.Context, params *GetMembersInput, optFns ...func(*Options)) (*GetMembersOutput, error)
Returns the details for the Security Hub member accounts for the specified account IDs. A master account can be either a delegated Security Hub administrator account for an organization or a master account that enabled Security Hub manually. The results include both member accounts that are in an organization and accounts that were invited manually.
func (*Client) InviteMembers ¶
func (c *Client) InviteMembers(ctx context.Context, params *InviteMembersInput, optFns ...func(*Options)) (*InviteMembersOutput, error)
Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from. This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations. Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub. When the account owner enables Security Hub and accepts the invitation to become a member account, the master account can view the findings generated from the member account.
func (*Client) ListEnabledProductsForImport ¶
func (c *Client) ListEnabledProductsForImport(ctx context.Context, params *ListEnabledProductsForImportInput, optFns ...func(*Options)) (*ListEnabledProductsForImportOutput, error)
Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
func (*Client) ListInvitations ¶
func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInput, optFns ...func(*Options)) (*ListInvitationsOutput, error)
Lists all Security Hub membership invitations that were sent to the current AWS account. This operation is only used by accounts that do not belong to an organization. Organization accounts do not receive invitations.
func (*Client) ListMembers ¶
func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error)
Lists details about all member accounts for the current Security Hub master account. The results include both member accounts that belong to an organization and member accounts that were invited manually.
func (*Client) ListOrganizationAdminAccounts ¶
func (c *Client) ListOrganizationAdminAccounts(ctx context.Context, params *ListOrganizationAdminAccountsInput, optFns ...func(*Options)) (*ListOrganizationAdminAccountsOutput, error)
Lists the Security Hub administrator accounts. Can only be called by the organization management account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Returns a list of tags associated with a resource.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds one or more tags to a resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from a resource.
func (*Client) UpdateActionTarget ¶
func (c *Client) UpdateActionTarget(ctx context.Context, params *UpdateActionTargetInput, optFns ...func(*Options)) (*UpdateActionTargetOutput, error)
Updates the name and description of a custom action target in Security Hub.
func (*Client) UpdateFindings ¶
func (c *Client) UpdateFindings(ctx context.Context, params *UpdateFindingsInput, optFns ...func(*Options)) (*UpdateFindingsOutput, error)
UpdateFindings is deprecated. Instead of UpdateFindings, use BatchUpdateFindings. Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.
func (*Client) UpdateInsight ¶
func (c *Client) UpdateInsight(ctx context.Context, params *UpdateInsightInput, optFns ...func(*Options)) (*UpdateInsightOutput, error)
Updates the Security Hub insight identified by the specified insight ARN.
func (*Client) UpdateOrganizationConfiguration ¶
func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *UpdateOrganizationConfigurationInput, optFns ...func(*Options)) (*UpdateOrganizationConfigurationOutput, error)
Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.
func (*Client) UpdateSecurityHubConfiguration ¶
func (c *Client) UpdateSecurityHubConfiguration(ctx context.Context, params *UpdateSecurityHubConfigurationInput, optFns ...func(*Options)) (*UpdateSecurityHubConfigurationOutput, error)
Updates configuration options for Security Hub.
func (*Client) UpdateStandardsControl ¶
func (c *Client) UpdateStandardsControl(ctx context.Context, params *UpdateStandardsControlInput, optFns ...func(*Options)) (*UpdateStandardsControlOutput, error)
Used to control whether an individual security standard control is enabled or disabled.
type CreateActionTargetInput ¶
type CreateActionTargetInput struct { // The description for the custom action target. // // This member is required. Description *string // The ID for the custom action target. // // This member is required. Id *string // The name of the custom action target. // // This member is required. Name *string }
type CreateActionTargetOutput ¶
type CreateActionTargetOutput struct { // The ARN for the custom action target. // // This member is required. ActionTargetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateInsightInput ¶
type CreateInsightInput struct { // One or more attributes used to filter the findings included in the insight. The // insight only includes findings that match the criteria defined in the filters. // // This member is required. Filters *types.AwsSecurityFindingFilters // The attribute used to group the findings for the insight. The grouping attribute // identifies the type of item that the insight applies to. For example, if an // insight is grouped by resource identifier, then the insight produces a list of // resource identifiers. // // This member is required. GroupByAttribute *string // The name of the custom insight to create. // // This member is required. Name *string }
type CreateInsightOutput ¶
type CreateInsightOutput struct { // The ARN of the insight created. // // This member is required. InsightArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateMembersInput ¶
type CreateMembersInput struct { // The list of accounts to associate with the Security Hub master account. For each // account, the list includes the account ID and optionally the email address. // // This member is required. AccountDetails []types.AccountDetails }
type CreateMembersOutput ¶
type CreateMembersOutput struct { // The list of AWS accounts that were not processed. For each account, the list // includes the account ID and the email address. UnprocessedAccounts []types.Result // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeclineInvitationsInput ¶
type DeclineInvitationsInput struct { // The list of account IDs for the accounts from which to decline the invitations // to Security Hub. // // This member is required. AccountIds []string }
type DeclineInvitationsOutput ¶
type DeclineInvitationsOutput struct { // The list of AWS accounts that were not processed. For each account, the list // includes the account ID and the email address. UnprocessedAccounts []types.Result // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteActionTargetInput ¶
type DeleteActionTargetInput struct { // The ARN of the custom action target to delete. // // This member is required. ActionTargetArn *string }
type DeleteActionTargetOutput ¶
type DeleteActionTargetOutput struct { // The ARN of the custom action target that was deleted. // // This member is required. ActionTargetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteInsightInput ¶
type DeleteInsightInput struct { // The ARN of the insight to delete. // // This member is required. InsightArn *string }
type DeleteInsightOutput ¶
type DeleteInsightOutput struct { // The ARN of the insight that was deleted. // // This member is required. InsightArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteInvitationsInput ¶
type DeleteInvitationsInput struct { // The list of the account IDs that sent the invitations to delete. // // This member is required. AccountIds []string }
type DeleteInvitationsOutput ¶
type DeleteInvitationsOutput struct { // The list of AWS accounts for which the invitations were not deleted. For each // account, the list includes the account ID and the email address. UnprocessedAccounts []types.Result // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteMembersInput ¶
type DeleteMembersInput struct { // The list of account IDs for the member accounts to delete. // // This member is required. AccountIds []string }
type DeleteMembersOutput ¶
type DeleteMembersOutput struct { // The list of AWS accounts that were not deleted. For each account, the list // includes the account ID and the email address. UnprocessedAccounts []types.Result // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeActionTargetsAPIClient ¶
type DescribeActionTargetsAPIClient interface { DescribeActionTargets(context.Context, *DescribeActionTargetsInput, ...func(*Options)) (*DescribeActionTargetsOutput, error) }
DescribeActionTargetsAPIClient is a client that implements the DescribeActionTargets operation.
type DescribeActionTargetsInput ¶
type DescribeActionTargetsInput struct { // A list of custom action target ARNs for the custom action targets to retrieve. ActionTargetArns []string // The maximum number of results to return. MaxResults int32 // The token that is required for pagination. On your first call to the // DescribeActionTargets operation, set the value of this parameter to NULL. For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string }
type DescribeActionTargetsOutput ¶
type DescribeActionTargetsOutput struct { // A list of ActionTarget objects. Each object includes the ActionTargetArn, // Description, and Name of a custom action target available in Security Hub. // // This member is required. ActionTargets []types.ActionTarget // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeActionTargetsPaginator ¶
type DescribeActionTargetsPaginator struct {
// contains filtered or unexported fields
}
DescribeActionTargetsPaginator is a paginator for DescribeActionTargets
func NewDescribeActionTargetsPaginator ¶
func NewDescribeActionTargetsPaginator(client DescribeActionTargetsAPIClient, params *DescribeActionTargetsInput, optFns ...func(*DescribeActionTargetsPaginatorOptions)) *DescribeActionTargetsPaginator
NewDescribeActionTargetsPaginator returns a new DescribeActionTargetsPaginator
func (*DescribeActionTargetsPaginator) HasMorePages ¶
func (p *DescribeActionTargetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeActionTargetsPaginator) NextPage ¶
func (p *DescribeActionTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeActionTargetsOutput, error)
NextPage retrieves the next DescribeActionTargets page.
type DescribeActionTargetsPaginatorOptions ¶
type DescribeActionTargetsPaginatorOptions struct { // The maximum number of results to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeActionTargetsPaginatorOptions is the paginator options for DescribeActionTargets
type DescribeHubInput ¶
type DescribeHubInput struct { // The ARN of the Hub resource to retrieve. HubArn *string }
type DescribeHubOutput ¶
type DescribeHubOutput struct { // Whether to automatically enable new controls when they are added to standards // that are enabled. If set to true, then new controls for enabled standards are // enabled automatically. If set to false, then new controls are not enabled. AutoEnableControls bool // The ARN of the Hub resource that was retrieved. HubArn *string // The date and time when Security Hub was enabled in the account. SubscribedAt *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeOrganizationConfigurationInput ¶
type DescribeOrganizationConfigurationInput struct { }
type DescribeOrganizationConfigurationOutput ¶
type DescribeOrganizationConfigurationOutput struct { // Whether to automatically enable Security Hub for new accounts in the // organization. If set to true, then Security Hub is enabled for new accounts. If // set to false, then new accounts are not added automatically. AutoEnable bool // Whether the maximum number of allowed member accounts are already associated // with the Security Hub administrator account. MemberAccountLimitReached bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeProductsAPIClient ¶
type DescribeProductsAPIClient interface { DescribeProducts(context.Context, *DescribeProductsInput, ...func(*Options)) (*DescribeProductsOutput, error) }
DescribeProductsAPIClient is a client that implements the DescribeProducts operation.
type DescribeProductsInput ¶
type DescribeProductsInput struct { // The maximum number of results to return. MaxResults int32 // The token that is required for pagination. On your first call to the // DescribeProducts operation, set the value of this parameter to NULL. For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string // The ARN of the integration to return. ProductArn *string }
type DescribeProductsOutput ¶
type DescribeProductsOutput struct { // A list of products, including details for each product. // // This member is required. Products []types.Product // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeProductsPaginator ¶
type DescribeProductsPaginator struct {
// contains filtered or unexported fields
}
DescribeProductsPaginator is a paginator for DescribeProducts
func NewDescribeProductsPaginator ¶
func NewDescribeProductsPaginator(client DescribeProductsAPIClient, params *DescribeProductsInput, optFns ...func(*DescribeProductsPaginatorOptions)) *DescribeProductsPaginator
NewDescribeProductsPaginator returns a new DescribeProductsPaginator
func (*DescribeProductsPaginator) HasMorePages ¶
func (p *DescribeProductsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeProductsPaginator) NextPage ¶
func (p *DescribeProductsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeProductsOutput, error)
NextPage retrieves the next DescribeProducts page.
type DescribeProductsPaginatorOptions ¶
type DescribeProductsPaginatorOptions struct { // The maximum number of results to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeProductsPaginatorOptions is the paginator options for DescribeProducts
type DescribeStandardsAPIClient ¶
type DescribeStandardsAPIClient interface { DescribeStandards(context.Context, *DescribeStandardsInput, ...func(*Options)) (*DescribeStandardsOutput, error) }
DescribeStandardsAPIClient is a client that implements the DescribeStandards operation.
type DescribeStandardsControlsAPIClient ¶
type DescribeStandardsControlsAPIClient interface { DescribeStandardsControls(context.Context, *DescribeStandardsControlsInput, ...func(*Options)) (*DescribeStandardsControlsOutput, error) }
DescribeStandardsControlsAPIClient is a client that implements the DescribeStandardsControls operation.
type DescribeStandardsControlsInput ¶
type DescribeStandardsControlsInput struct { // The ARN of a resource that represents your subscription to a supported standard. // To get the subscription ARNs of the standards you have enabled, use the // GetEnabledStandards operation. // // This member is required. StandardsSubscriptionArn *string // The maximum number of security standard controls to return. MaxResults int32 // The token that is required for pagination. On your first call to the // DescribeStandardsControls operation, set the value of this parameter to NULL. // For subsequent calls to the operation, to continue listing data, set the value // of this parameter to the value returned from the previous response. NextToken *string }
type DescribeStandardsControlsOutput ¶
type DescribeStandardsControlsOutput struct { // A list of security standards controls. Controls []types.StandardsControl // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStandardsControlsPaginator ¶
type DescribeStandardsControlsPaginator struct {
// contains filtered or unexported fields
}
DescribeStandardsControlsPaginator is a paginator for DescribeStandardsControls
func NewDescribeStandardsControlsPaginator ¶
func NewDescribeStandardsControlsPaginator(client DescribeStandardsControlsAPIClient, params *DescribeStandardsControlsInput, optFns ...func(*DescribeStandardsControlsPaginatorOptions)) *DescribeStandardsControlsPaginator
NewDescribeStandardsControlsPaginator returns a new DescribeStandardsControlsPaginator
func (*DescribeStandardsControlsPaginator) HasMorePages ¶
func (p *DescribeStandardsControlsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeStandardsControlsPaginator) NextPage ¶
func (p *DescribeStandardsControlsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStandardsControlsOutput, error)
NextPage retrieves the next DescribeStandardsControls page.
type DescribeStandardsControlsPaginatorOptions ¶
type DescribeStandardsControlsPaginatorOptions struct { // The maximum number of security standard controls to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeStandardsControlsPaginatorOptions is the paginator options for DescribeStandardsControls
type DescribeStandardsInput ¶
type DescribeStandardsInput struct { // The maximum number of standards to return. MaxResults int32 // The token that is required for pagination. On your first call to the // DescribeStandards operation, set the value of this parameter to NULL. For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string }
type DescribeStandardsOutput ¶
type DescribeStandardsOutput struct { // The pagination token to use to request the next page of results. NextToken *string // A list of available standards. Standards []types.Standard // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStandardsPaginator ¶
type DescribeStandardsPaginator struct {
// contains filtered or unexported fields
}
DescribeStandardsPaginator is a paginator for DescribeStandards
func NewDescribeStandardsPaginator ¶
func NewDescribeStandardsPaginator(client DescribeStandardsAPIClient, params *DescribeStandardsInput, optFns ...func(*DescribeStandardsPaginatorOptions)) *DescribeStandardsPaginator
NewDescribeStandardsPaginator returns a new DescribeStandardsPaginator
func (*DescribeStandardsPaginator) HasMorePages ¶
func (p *DescribeStandardsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeStandardsPaginator) NextPage ¶
func (p *DescribeStandardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStandardsOutput, error)
NextPage retrieves the next DescribeStandards page.
type DescribeStandardsPaginatorOptions ¶
type DescribeStandardsPaginatorOptions struct { // The maximum number of standards to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeStandardsPaginatorOptions is the paginator options for DescribeStandards
type DisableImportFindingsForProductInput ¶
type DisableImportFindingsForProductInput struct { // The ARN of the integrated product to disable the integration for. // // This member is required. ProductSubscriptionArn *string }
type DisableImportFindingsForProductOutput ¶
type DisableImportFindingsForProductOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisableOrganizationAdminAccountInput ¶
type DisableOrganizationAdminAccountInput struct { // The AWS account identifier of the Security Hub administrator account. // // This member is required. AdminAccountId *string }
type DisableOrganizationAdminAccountOutput ¶
type DisableOrganizationAdminAccountOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisableSecurityHubInput ¶
type DisableSecurityHubInput struct { }
type DisableSecurityHubOutput ¶
type DisableSecurityHubOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateFromMasterAccountInput ¶
type DisassociateFromMasterAccountInput struct { }
type DisassociateFromMasterAccountOutput ¶
type DisassociateFromMasterAccountOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateMembersInput ¶
type DisassociateMembersInput struct { // The account IDs of the member accounts to disassociate from the master account. // // This member is required. AccountIds []string }
type DisassociateMembersOutput ¶
type DisassociateMembersOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EnableImportFindingsForProductInput ¶
type EnableImportFindingsForProductInput struct { // The ARN of the product to enable the integration for. // // This member is required. ProductArn *string }
type EnableImportFindingsForProductOutput ¶
type EnableImportFindingsForProductOutput struct { // The ARN of your subscription to the product to enable integrations for. ProductSubscriptionArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EnableOrganizationAdminAccountInput ¶
type EnableOrganizationAdminAccountInput struct { // The AWS account identifier of the account to designate as the Security Hub // administrator account. // // This member is required. AdminAccountId *string }
type EnableOrganizationAdminAccountOutput ¶
type EnableOrganizationAdminAccountOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EnableSecurityHubInput ¶
type EnableSecurityHubInput struct { // Whether to enable the security standards that Security Hub has designated as // automatically enabled. If you do not provide a value for EnableDefaultStandards, // it is set to true. To not enable the automatically enabled standards, set // EnableDefaultStandards to false. EnableDefaultStandards bool // The tags to add to the hub resource when you enable Security Hub. Tags map[string]string }
type EnableSecurityHubOutput ¶
type EnableSecurityHubOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetEnabledStandardsAPIClient ¶
type GetEnabledStandardsAPIClient interface { GetEnabledStandards(context.Context, *GetEnabledStandardsInput, ...func(*Options)) (*GetEnabledStandardsOutput, error) }
GetEnabledStandardsAPIClient is a client that implements the GetEnabledStandards operation.
type GetEnabledStandardsInput ¶
type GetEnabledStandardsInput struct { // The maximum number of results to return in the response. MaxResults int32 // The token that is required for pagination. On your first call to the // GetEnabledStandards operation, set the value of this parameter to NULL. For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string // The list of the standards subscription ARNs for the standards to retrieve. StandardsSubscriptionArns []string }
type GetEnabledStandardsOutput ¶
type GetEnabledStandardsOutput struct { // The pagination token to use to request the next page of results. NextToken *string // The list of StandardsSubscriptions objects that include information about the // enabled standards. StandardsSubscriptions []types.StandardsSubscription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetEnabledStandardsPaginator ¶
type GetEnabledStandardsPaginator struct {
// contains filtered or unexported fields
}
GetEnabledStandardsPaginator is a paginator for GetEnabledStandards
func NewGetEnabledStandardsPaginator ¶
func NewGetEnabledStandardsPaginator(client GetEnabledStandardsAPIClient, params *GetEnabledStandardsInput, optFns ...func(*GetEnabledStandardsPaginatorOptions)) *GetEnabledStandardsPaginator
NewGetEnabledStandardsPaginator returns a new GetEnabledStandardsPaginator
func (*GetEnabledStandardsPaginator) HasMorePages ¶
func (p *GetEnabledStandardsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetEnabledStandardsPaginator) NextPage ¶
func (p *GetEnabledStandardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetEnabledStandardsOutput, error)
NextPage retrieves the next GetEnabledStandards page.
type GetEnabledStandardsPaginatorOptions ¶
type GetEnabledStandardsPaginatorOptions struct { // The maximum number of results to return in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetEnabledStandardsPaginatorOptions is the paginator options for GetEnabledStandards
type GetFindingsAPIClient ¶
type GetFindingsAPIClient interface { GetFindings(context.Context, *GetFindingsInput, ...func(*Options)) (*GetFindingsOutput, error) }
GetFindingsAPIClient is a client that implements the GetFindings operation.
type GetFindingsInput ¶
type GetFindingsInput struct { // The finding attributes used to define a condition to filter the returned // findings. You can filter by up to 10 finding attributes. For each attribute, you // can provide up to 20 filter values. Note that in the available filter fields, // WorkflowState is deprecated. To search for a finding based on its workflow // status, use WorkflowStatus. Filters *types.AwsSecurityFindingFilters // The maximum number of findings to return. MaxResults int32 // The token that is required for pagination. On your first call to the GetFindings // operation, set the value of this parameter to NULL. For subsequent calls to the // operation, to continue listing data, set the value of this parameter to the // value returned from the previous response. NextToken *string // The finding attributes used to sort the list of returned findings. SortCriteria []types.SortCriterion }
type GetFindingsOutput ¶
type GetFindingsOutput struct { // The findings that matched the filters specified in the request. // // This member is required. Findings []types.AwsSecurityFinding // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetFindingsPaginator ¶
type GetFindingsPaginator struct {
// contains filtered or unexported fields
}
GetFindingsPaginator is a paginator for GetFindings
func NewGetFindingsPaginator ¶
func NewGetFindingsPaginator(client GetFindingsAPIClient, params *GetFindingsInput, optFns ...func(*GetFindingsPaginatorOptions)) *GetFindingsPaginator
NewGetFindingsPaginator returns a new GetFindingsPaginator
func (*GetFindingsPaginator) HasMorePages ¶
func (p *GetFindingsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetFindingsPaginator) NextPage ¶
func (p *GetFindingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFindingsOutput, error)
NextPage retrieves the next GetFindings page.
type GetFindingsPaginatorOptions ¶
type GetFindingsPaginatorOptions struct { // The maximum number of findings to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetFindingsPaginatorOptions is the paginator options for GetFindings
type GetInsightResultsInput ¶
type GetInsightResultsInput struct { // The ARN of the insight for which to return results. // // This member is required. InsightArn *string }
type GetInsightResultsOutput ¶
type GetInsightResultsOutput struct { // The insight results returned by the operation. // // This member is required. InsightResults *types.InsightResults // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetInsightsAPIClient ¶
type GetInsightsAPIClient interface { GetInsights(context.Context, *GetInsightsInput, ...func(*Options)) (*GetInsightsOutput, error) }
GetInsightsAPIClient is a client that implements the GetInsights operation.
type GetInsightsInput ¶
type GetInsightsInput struct { // The ARNs of the insights to describe. If you do not provide any insight ARNs, // then GetInsights returns all of your custom insights. It does not return any // managed insights. InsightArns []string // The maximum number of items to return in the response. MaxResults int32 // The token that is required for pagination. On your first call to the GetInsights // operation, set the value of this parameter to NULL. For subsequent calls to the // operation, to continue listing data, set the value of this parameter to the // value returned from the previous response. NextToken *string }
type GetInsightsOutput ¶
type GetInsightsOutput struct { // The insights returned by the operation. // // This member is required. Insights []types.Insight // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetInsightsPaginator ¶
type GetInsightsPaginator struct {
// contains filtered or unexported fields
}
GetInsightsPaginator is a paginator for GetInsights
func NewGetInsightsPaginator ¶
func NewGetInsightsPaginator(client GetInsightsAPIClient, params *GetInsightsInput, optFns ...func(*GetInsightsPaginatorOptions)) *GetInsightsPaginator
NewGetInsightsPaginator returns a new GetInsightsPaginator
func (*GetInsightsPaginator) HasMorePages ¶
func (p *GetInsightsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetInsightsPaginator) NextPage ¶
func (p *GetInsightsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInsightsOutput, error)
NextPage retrieves the next GetInsights page.
type GetInsightsPaginatorOptions ¶
type GetInsightsPaginatorOptions struct { // The maximum number of items to return in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetInsightsPaginatorOptions is the paginator options for GetInsights
type GetInvitationsCountInput ¶
type GetInvitationsCountInput struct { }
type GetInvitationsCountOutput ¶
type GetInvitationsCountOutput struct { // The number of all membership invitations sent to this Security Hub member // account, not including the currently accepted invitation. InvitationsCount int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetMasterAccountInput ¶
type GetMasterAccountInput struct { }
type GetMasterAccountOutput ¶
type GetMasterAccountOutput struct { // A list of details about the Security Hub master account for the current member // account. Master *types.Invitation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetMembersInput ¶
type GetMembersInput struct { // The list of account IDs for the Security Hub member accounts to return the // details for. // // This member is required. AccountIds []string }
type GetMembersOutput ¶
type GetMembersOutput struct { // The list of details about the Security Hub member accounts. Members []types.Member // The list of AWS accounts that could not be processed. For each account, the list // includes the account ID and the email address. UnprocessedAccounts []types.Result // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type InviteMembersInput ¶
type InviteMembersInput struct { // The list of account IDs of the AWS accounts to invite to Security Hub as // members. // // This member is required. AccountIds []string }
type InviteMembersOutput ¶
type InviteMembersOutput struct { // The list of AWS accounts that could not be processed. For each account, the list // includes the account ID and the email address. UnprocessedAccounts []types.Result // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListEnabledProductsForImportAPIClient ¶
type ListEnabledProductsForImportAPIClient interface { ListEnabledProductsForImport(context.Context, *ListEnabledProductsForImportInput, ...func(*Options)) (*ListEnabledProductsForImportOutput, error) }
ListEnabledProductsForImportAPIClient is a client that implements the ListEnabledProductsForImport operation.
type ListEnabledProductsForImportInput ¶
type ListEnabledProductsForImportInput struct { // The maximum number of items to return in the response. MaxResults int32 // The token that is required for pagination. On your first call to the // ListEnabledProductsForImport operation, set the value of this parameter to NULL. // For subsequent calls to the operation, to continue listing data, set the value // of this parameter to the value returned from the previous response. NextToken *string }
type ListEnabledProductsForImportOutput ¶
type ListEnabledProductsForImportOutput struct { // The pagination token to use to request the next page of results. NextToken *string // The list of ARNs for the resources that represent your subscriptions to // products. ProductSubscriptions []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListEnabledProductsForImportPaginator ¶
type ListEnabledProductsForImportPaginator struct {
// contains filtered or unexported fields
}
ListEnabledProductsForImportPaginator is a paginator for ListEnabledProductsForImport
func NewListEnabledProductsForImportPaginator ¶
func NewListEnabledProductsForImportPaginator(client ListEnabledProductsForImportAPIClient, params *ListEnabledProductsForImportInput, optFns ...func(*ListEnabledProductsForImportPaginatorOptions)) *ListEnabledProductsForImportPaginator
NewListEnabledProductsForImportPaginator returns a new ListEnabledProductsForImportPaginator
func (*ListEnabledProductsForImportPaginator) HasMorePages ¶
func (p *ListEnabledProductsForImportPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEnabledProductsForImportPaginator) NextPage ¶
func (p *ListEnabledProductsForImportPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnabledProductsForImportOutput, error)
NextPage retrieves the next ListEnabledProductsForImport page.
type ListEnabledProductsForImportPaginatorOptions ¶
type ListEnabledProductsForImportPaginatorOptions struct { // The maximum number of items to return in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListEnabledProductsForImportPaginatorOptions is the paginator options for ListEnabledProductsForImport
type ListInvitationsAPIClient ¶
type ListInvitationsAPIClient interface { ListInvitations(context.Context, *ListInvitationsInput, ...func(*Options)) (*ListInvitationsOutput, error) }
ListInvitationsAPIClient is a client that implements the ListInvitations operation.
type ListInvitationsInput ¶
type ListInvitationsInput struct { // The maximum number of items to return in the response. MaxResults int32 // The token that is required for pagination. On your first call to the // ListInvitations operation, set the value of this parameter to NULL. For // subsequent calls to the operation, to continue listing data, set the value of // this parameter to the value returned from the previous response. NextToken *string }
type ListInvitationsOutput ¶
type ListInvitationsOutput struct { // The details of the invitations returned by the operation. Invitations []types.Invitation // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListInvitationsPaginator ¶
type ListInvitationsPaginator struct {
// contains filtered or unexported fields
}
ListInvitationsPaginator is a paginator for ListInvitations
func NewListInvitationsPaginator ¶
func NewListInvitationsPaginator(client ListInvitationsAPIClient, params *ListInvitationsInput, optFns ...func(*ListInvitationsPaginatorOptions)) *ListInvitationsPaginator
NewListInvitationsPaginator returns a new ListInvitationsPaginator
func (*ListInvitationsPaginator) HasMorePages ¶
func (p *ListInvitationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListInvitationsPaginator) NextPage ¶
func (p *ListInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInvitationsOutput, error)
NextPage retrieves the next ListInvitations page.
type ListInvitationsPaginatorOptions ¶
type ListInvitationsPaginatorOptions struct { // The maximum number of items to return in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListInvitationsPaginatorOptions is the paginator options for ListInvitations
type ListMembersAPIClient ¶
type ListMembersAPIClient interface { ListMembers(context.Context, *ListMembersInput, ...func(*Options)) (*ListMembersOutput, error) }
ListMembersAPIClient is a client that implements the ListMembers operation.
type ListMembersInput ¶
type ListMembersInput struct { // The maximum number of items to return in the response. MaxResults int32 // The token that is required for pagination. On your first call to the ListMembers // operation, set the value of this parameter to NULL. For subsequent calls to the // operation, to continue listing data, set the value of this parameter to the // value returned from the previous response. NextToken *string // Specifies which member accounts to include in the response based on their // relationship status with the master account. The default value is TRUE. If // OnlyAssociated is set to TRUE, the response includes member accounts whose // relationship status with the master is set to ENABLED. If OnlyAssociated is set // to FALSE, the response includes all existing member accounts. OnlyAssociated bool }
type ListMembersOutput ¶
type ListMembersOutput struct { // Member details returned by the operation. Members []types.Member // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListMembersPaginator ¶
type ListMembersPaginator struct {
// contains filtered or unexported fields
}
ListMembersPaginator is a paginator for ListMembers
func NewListMembersPaginator ¶
func NewListMembersPaginator(client ListMembersAPIClient, params *ListMembersInput, optFns ...func(*ListMembersPaginatorOptions)) *ListMembersPaginator
NewListMembersPaginator returns a new ListMembersPaginator
func (*ListMembersPaginator) HasMorePages ¶
func (p *ListMembersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMembersPaginator) NextPage ¶
func (p *ListMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMembersOutput, error)
NextPage retrieves the next ListMembers page.
type ListMembersPaginatorOptions ¶
type ListMembersPaginatorOptions struct { // The maximum number of items to return in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListMembersPaginatorOptions is the paginator options for ListMembers
type ListOrganizationAdminAccountsAPIClient ¶
type ListOrganizationAdminAccountsAPIClient interface { ListOrganizationAdminAccounts(context.Context, *ListOrganizationAdminAccountsInput, ...func(*Options)) (*ListOrganizationAdminAccountsOutput, error) }
ListOrganizationAdminAccountsAPIClient is a client that implements the ListOrganizationAdminAccounts operation.
type ListOrganizationAdminAccountsInput ¶
type ListOrganizationAdminAccountsInput struct { // The maximum number of items to return in the response. MaxResults int32 // The token that is required for pagination. On your first call to the // ListOrganizationAdminAccounts operation, set the value of this parameter to // NULL. For subsequent calls to the operation, to continue listing data, set the // value of this parameter to the value returned from the previous response. NextToken *string }
type ListOrganizationAdminAccountsOutput ¶
type ListOrganizationAdminAccountsOutput struct { // The list of Security Hub administrator accounts. AdminAccounts []types.AdminAccount // The pagination token to use to request the next page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListOrganizationAdminAccountsPaginator ¶
type ListOrganizationAdminAccountsPaginator struct {
// contains filtered or unexported fields
}
ListOrganizationAdminAccountsPaginator is a paginator for ListOrganizationAdminAccounts
func NewListOrganizationAdminAccountsPaginator ¶
func NewListOrganizationAdminAccountsPaginator(client ListOrganizationAdminAccountsAPIClient, params *ListOrganizationAdminAccountsInput, optFns ...func(*ListOrganizationAdminAccountsPaginatorOptions)) *ListOrganizationAdminAccountsPaginator
NewListOrganizationAdminAccountsPaginator returns a new ListOrganizationAdminAccountsPaginator
func (*ListOrganizationAdminAccountsPaginator) HasMorePages ¶
func (p *ListOrganizationAdminAccountsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOrganizationAdminAccountsPaginator) NextPage ¶
func (p *ListOrganizationAdminAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrganizationAdminAccountsOutput, error)
NextPage retrieves the next ListOrganizationAdminAccounts page.
type ListOrganizationAdminAccountsPaginatorOptions ¶
type ListOrganizationAdminAccountsPaginatorOptions struct { // The maximum number of items to return in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListOrganizationAdminAccountsPaginatorOptions is the paginator options for ListOrganizationAdminAccounts
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The ARN of the resource to retrieve tags for. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags associated with a resource. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // The ARN of the resource to apply the tags to. // // This member is required. ResourceArn *string // The tags to add to the resource. // // This member is required. Tags map[string]string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The ARN of the resource to remove the tags from. // // This member is required. ResourceArn *string // The tag keys associated with the tags to remove from the resource. // // This member is required. TagKeys []string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateActionTargetInput ¶
type UpdateActionTargetInput struct { // The ARN of the custom action target to update. // // This member is required. ActionTargetArn *string // The updated description for the custom action target. Description *string // The updated name of the custom action target. Name *string }
type UpdateActionTargetOutput ¶
type UpdateActionTargetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateFindingsInput ¶
type UpdateFindingsInput struct { // A collection of attributes that specify which findings you want to update. // // This member is required. Filters *types.AwsSecurityFindingFilters // The updated note for the finding. Note *types.NoteUpdate // The updated record state for the finding. RecordState types.RecordState }
type UpdateFindingsOutput ¶
type UpdateFindingsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateInsightInput ¶
type UpdateInsightInput struct { // The ARN of the insight that you want to update. // // This member is required. InsightArn *string // The updated filters that define this insight. Filters *types.AwsSecurityFindingFilters // The updated GroupBy attribute that defines this insight. GroupByAttribute *string // The updated name for the insight. Name *string }
type UpdateInsightOutput ¶
type UpdateInsightOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateOrganizationConfigurationInput ¶
type UpdateOrganizationConfigurationInput struct { // Whether to automatically enable Security Hub for new accounts in the // organization. By default, this is false, and new accounts are not added // automatically. To automatically enable Security Hub for new accounts, set this // to true. // // This member is required. AutoEnable bool }
type UpdateOrganizationConfigurationOutput ¶
type UpdateOrganizationConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateSecurityHubConfigurationInput ¶
type UpdateSecurityHubConfigurationInput struct { // Whether to automatically enable new controls when they are added to standards // that are enabled. By default, this is set to true, and new controls are enabled // automatically. To not automatically enable new controls, set this to false. AutoEnableControls bool }
type UpdateSecurityHubConfigurationOutput ¶
type UpdateSecurityHubConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateStandardsControlInput ¶
type UpdateStandardsControlInput struct { // The ARN of the security standard control to enable or disable. // // This member is required. StandardsControlArn *string // The updated status of the security standard control. ControlStatus types.ControlStatus // A description of the reason why you are disabling a security standard control. // If you are disabling a control, then this is required. DisabledReason *string }
type UpdateStandardsControlOutput ¶
type UpdateStandardsControlOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_AcceptInvitation.go api_op_BatchDisableStandards.go api_op_BatchEnableStandards.go api_op_BatchImportFindings.go api_op_BatchUpdateFindings.go api_op_CreateActionTarget.go api_op_CreateInsight.go api_op_CreateMembers.go api_op_DeclineInvitations.go api_op_DeleteActionTarget.go api_op_DeleteInsight.go api_op_DeleteInvitations.go api_op_DeleteMembers.go api_op_DescribeActionTargets.go api_op_DescribeHub.go api_op_DescribeOrganizationConfiguration.go api_op_DescribeProducts.go api_op_DescribeStandards.go api_op_DescribeStandardsControls.go api_op_DisableImportFindingsForProduct.go api_op_DisableOrganizationAdminAccount.go api_op_DisableSecurityHub.go api_op_DisassociateFromMasterAccount.go api_op_DisassociateMembers.go api_op_EnableImportFindingsForProduct.go api_op_EnableOrganizationAdminAccount.go api_op_EnableSecurityHub.go api_op_GetEnabledStandards.go api_op_GetFindings.go api_op_GetInsightResults.go api_op_GetInsights.go api_op_GetInvitationsCount.go api_op_GetMasterAccount.go api_op_GetMembers.go api_op_InviteMembers.go api_op_ListEnabledProductsForImport.go api_op_ListInvitations.go api_op_ListMembers.go api_op_ListOrganizationAdminAccounts.go api_op_ListTagsForResource.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateActionTarget.go api_op_UpdateFindings.go api_op_UpdateInsight.go api_op_UpdateOrganizationConfiguration.go api_op_UpdateSecurityHubConfiguration.go api_op_UpdateStandardsControl.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.2.1
- Published
- Apr 2, 2021
- Platform
- js/wasm
- Imports
- 27 packages
- Last checked
- 1 second ago –
Tools for package owners.