macie2 – github.com/aws/aws-sdk-go-v2/service/macie2 Index | Files | Directories

package macie2

import "github.com/aws/aws-sdk-go-v2/service/macie2"

Package macie2 provides the API client, operations, and parameter types for Amazon Macie 2.

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.

Index

Constants

const ServiceAPIVersion = "2020-01-01"
const ServiceID = "Macie2"

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 unique identifier for the invitation to accept.
	//
	// This member is required.
	InvitationId *string

	// The Amazon Web Services account ID for the account that sent the invitation.
	AdministratorAccountId *string

	// (Deprecated) The Amazon Web Services account ID for the account that sent the
	// invitation. This property has been replaced by the administratorAccountId
	// property and is retained only for backward compatibility.
	MasterAccount *string
	// contains filtered or unexported fields
}

type AcceptInvitationOutput

type AcceptInvitationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetCustomDataIdentifiersInput

type BatchGetCustomDataIdentifiersInput struct {

	// An array of custom data identifier IDs, one for each custom data identifier to
	// retrieve information about.
	Ids []string
	// contains filtered or unexported fields
}

type BatchGetCustomDataIdentifiersOutput

type BatchGetCustomDataIdentifiersOutput struct {

	// An array of objects, one for each custom data identifier that meets the criteria
	// specified in the request.
	CustomDataIdentifiers []types.BatchGetCustomDataIdentifierSummary

	// An array of custom data identifier IDs, one for each custom data identifier that
	// was specified in the request but doesn't correlate to an existing custom data
	// identifier.
	NotFoundIdentifierIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client

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

Client provides the API client to make operations call for Amazon Macie 2.

func New

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

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

func NewFromConfig

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

NewFromConfig returns a new client from the provided config.

func (*Client) AcceptInvitation

func (c *Client) AcceptInvitation(ctx context.Context, params *AcceptInvitationInput, optFns ...func(*Options)) (*AcceptInvitationOutput, error)

Accepts an Amazon Macie membership invitation that was received from a specific account.

func (*Client) BatchGetCustomDataIdentifiers

func (c *Client) BatchGetCustomDataIdentifiers(ctx context.Context, params *BatchGetCustomDataIdentifiersInput, optFns ...func(*Options)) (*BatchGetCustomDataIdentifiersOutput, error)

Retrieves information about one or more custom data identifiers.

func (*Client) CreateClassificationJob

func (c *Client) CreateClassificationJob(ctx context.Context, params *CreateClassificationJobInput, optFns ...func(*Options)) (*CreateClassificationJobOutput, error)

Creates and defines the settings for a classification job.

func (*Client) CreateCustomDataIdentifier

func (c *Client) CreateCustomDataIdentifier(ctx context.Context, params *CreateCustomDataIdentifierInput, optFns ...func(*Options)) (*CreateCustomDataIdentifierOutput, error)

Creates and defines the criteria and other settings for a custom data identifier.

func (*Client) CreateFindingsFilter

func (c *Client) CreateFindingsFilter(ctx context.Context, params *CreateFindingsFilterInput, optFns ...func(*Options)) (*CreateFindingsFilterOutput, error)

Creates and defines the criteria and other settings for a findings filter.

func (*Client) CreateInvitations

func (c *Client) CreateInvitations(ctx context.Context, params *CreateInvitationsInput, optFns ...func(*Options)) (*CreateInvitationsOutput, error)

Sends an Amazon Macie membership invitation to one or more accounts.

func (*Client) CreateMember

func (c *Client) CreateMember(ctx context.Context, params *CreateMemberInput, optFns ...func(*Options)) (*CreateMemberOutput, error)

Associates an account with an Amazon Macie administrator account.

func (*Client) CreateSampleFindings

func (c *Client) CreateSampleFindings(ctx context.Context, params *CreateSampleFindingsInput, optFns ...func(*Options)) (*CreateSampleFindingsOutput, error)

Creates sample findings.

func (*Client) DeclineInvitations

func (c *Client) DeclineInvitations(ctx context.Context, params *DeclineInvitationsInput, optFns ...func(*Options)) (*DeclineInvitationsOutput, error)

Declines Amazon Macie membership invitations that were received from specific accounts.

func (*Client) DeleteCustomDataIdentifier

func (c *Client) DeleteCustomDataIdentifier(ctx context.Context, params *DeleteCustomDataIdentifierInput, optFns ...func(*Options)) (*DeleteCustomDataIdentifierOutput, error)

Soft deletes a custom data identifier.

func (*Client) DeleteFindingsFilter

func (c *Client) DeleteFindingsFilter(ctx context.Context, params *DeleteFindingsFilterInput, optFns ...func(*Options)) (*DeleteFindingsFilterOutput, error)

Deletes a findings filter.

func (*Client) DeleteInvitations

func (c *Client) DeleteInvitations(ctx context.Context, params *DeleteInvitationsInput, optFns ...func(*Options)) (*DeleteInvitationsOutput, error)

Deletes Amazon Macie membership invitations that were received from specific accounts.

func (*Client) DeleteMember

func (c *Client) DeleteMember(ctx context.Context, params *DeleteMemberInput, optFns ...func(*Options)) (*DeleteMemberOutput, error)

Deletes the association between an Amazon Macie administrator account and an account.

func (*Client) DescribeBuckets

func (c *Client) DescribeBuckets(ctx context.Context, params *DescribeBucketsInput, optFns ...func(*Options)) (*DescribeBucketsOutput, error)

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.

func (*Client) DescribeClassificationJob

func (c *Client) DescribeClassificationJob(ctx context.Context, params *DescribeClassificationJobInput, optFns ...func(*Options)) (*DescribeClassificationJobOutput, error)

Retrieves the status and settings for a classification job.

func (*Client) DescribeOrganizationConfiguration

func (c *Client) DescribeOrganizationConfiguration(ctx context.Context, params *DescribeOrganizationConfigurationInput, optFns ...func(*Options)) (*DescribeOrganizationConfigurationOutput, error)

Retrieves the Amazon Macie configuration settings for an organization in Organizations.

func (*Client) DisableMacie

func (c *Client) DisableMacie(ctx context.Context, params *DisableMacieInput, optFns ...func(*Options)) (*DisableMacieOutput, error)

Disables Amazon Macie and deletes all settings and resources for a Macie account.

func (*Client) DisableOrganizationAdminAccount

func (c *Client) DisableOrganizationAdminAccount(ctx context.Context, params *DisableOrganizationAdminAccountInput, optFns ...func(*Options)) (*DisableOrganizationAdminAccountOutput, error)

Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.

func (*Client) DisassociateFromAdministratorAccount

func (c *Client) DisassociateFromAdministratorAccount(ctx context.Context, params *DisassociateFromAdministratorAccountInput, optFns ...func(*Options)) (*DisassociateFromAdministratorAccountOutput, error)

Disassociates a member account from its Amazon Macie administrator account.

func (*Client) DisassociateFromMasterAccount

func (c *Client) DisassociateFromMasterAccount(ctx context.Context, params *DisassociateFromMasterAccountInput, optFns ...func(*Options)) (*DisassociateFromMasterAccountOutput, error)

(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.

func (*Client) DisassociateMember

func (c *Client) DisassociateMember(ctx context.Context, params *DisassociateMemberInput, optFns ...func(*Options)) (*DisassociateMemberOutput, error)

Disassociates an Amazon Macie administrator account from a member account.

func (*Client) EnableMacie

func (c *Client) EnableMacie(ctx context.Context, params *EnableMacieInput, optFns ...func(*Options)) (*EnableMacieOutput, error)

Enables Amazon Macie and specifies the configuration settings for a Macie account.

func (*Client) EnableOrganizationAdminAccount

func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *EnableOrganizationAdminAccountInput, optFns ...func(*Options)) (*EnableOrganizationAdminAccountOutput, error)

Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.

func (*Client) GetAdministratorAccount

func (c *Client) GetAdministratorAccount(ctx context.Context, params *GetAdministratorAccountInput, optFns ...func(*Options)) (*GetAdministratorAccountOutput, error)

Retrieves information about the Amazon Macie administrator account for an account.

func (*Client) GetBucketStatistics

func (c *Client) GetBucketStatistics(ctx context.Context, params *GetBucketStatisticsInput, optFns ...func(*Options)) (*GetBucketStatisticsOutput, error)

Retrieves (queries) aggregated statistical data about S3 buckets that Amazon Macie monitors and analyzes.

func (*Client) GetClassificationExportConfiguration

func (c *Client) GetClassificationExportConfiguration(ctx context.Context, params *GetClassificationExportConfigurationInput, optFns ...func(*Options)) (*GetClassificationExportConfigurationOutput, error)

Retrieves the configuration settings for storing data classification results.

func (*Client) GetCustomDataIdentifier

func (c *Client) GetCustomDataIdentifier(ctx context.Context, params *GetCustomDataIdentifierInput, optFns ...func(*Options)) (*GetCustomDataIdentifierOutput, error)

Retrieves the criteria and other settings for a custom data identifier.

func (*Client) GetFindingStatistics

func (c *Client) GetFindingStatistics(ctx context.Context, params *GetFindingStatisticsInput, optFns ...func(*Options)) (*GetFindingStatisticsOutput, error)

Retrieves (queries) aggregated statistical data about findings.

func (*Client) GetFindings

func (c *Client) GetFindings(ctx context.Context, params *GetFindingsInput, optFns ...func(*Options)) (*GetFindingsOutput, error)

Retrieves the details of one or more findings.

func (*Client) GetFindingsFilter

func (c *Client) GetFindingsFilter(ctx context.Context, params *GetFindingsFilterInput, optFns ...func(*Options)) (*GetFindingsFilterOutput, error)

Retrieves the criteria and other settings for a findings filter.

func (*Client) GetFindingsPublicationConfiguration

func (c *Client) GetFindingsPublicationConfiguration(ctx context.Context, params *GetFindingsPublicationConfigurationInput, optFns ...func(*Options)) (*GetFindingsPublicationConfigurationOutput, error)

Retrieves the configuration settings for publishing findings to Security Hub.

func (*Client) GetInvitationsCount

func (c *Client) GetInvitationsCount(ctx context.Context, params *GetInvitationsCountInput, optFns ...func(*Options)) (*GetInvitationsCountOutput, error)

Retrieves the count of Amazon Macie membership invitations that were received by an account.

func (*Client) GetMacieSession

func (c *Client) GetMacieSession(ctx context.Context, params *GetMacieSessionInput, optFns ...func(*Options)) (*GetMacieSessionOutput, error)

Retrieves the current status and configuration settings for an Amazon Macie account.

func (*Client) GetMasterAccount

func (c *Client) GetMasterAccount(ctx context.Context, params *GetMasterAccountInput, optFns ...func(*Options)) (*GetMasterAccountOutput, error)

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.

func (*Client) GetMember

func (c *Client) GetMember(ctx context.Context, params *GetMemberInput, optFns ...func(*Options)) (*GetMemberOutput, error)

Retrieves information about an account that's associated with an Amazon Macie administrator account.

func (*Client) GetUsageStatistics

func (c *Client) GetUsageStatistics(ctx context.Context, params *GetUsageStatisticsInput, optFns ...func(*Options)) (*GetUsageStatisticsOutput, error)

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

func (*Client) GetUsageTotals

func (c *Client) GetUsageTotals(ctx context.Context, params *GetUsageTotalsInput, optFns ...func(*Options)) (*GetUsageTotalsOutput, error)

Retrieves (queries) aggregated usage data for an account.

func (*Client) ListClassificationJobs

func (c *Client) ListClassificationJobs(ctx context.Context, params *ListClassificationJobsInput, optFns ...func(*Options)) (*ListClassificationJobsOutput, error)

Retrieves a subset of information about one or more classification jobs.

func (*Client) ListCustomDataIdentifiers

func (c *Client) ListCustomDataIdentifiers(ctx context.Context, params *ListCustomDataIdentifiersInput, optFns ...func(*Options)) (*ListCustomDataIdentifiersOutput, error)

Retrieves a subset of information about all the custom data identifiers for an account.

func (*Client) ListFindings

func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, optFns ...func(*Options)) (*ListFindingsOutput, error)

Retrieves a subset of information about one or more findings.

func (*Client) ListFindingsFilters

func (c *Client) ListFindingsFilters(ctx context.Context, params *ListFindingsFiltersInput, optFns ...func(*Options)) (*ListFindingsFiltersOutput, error)

Retrieves a subset of information about all the findings filters for an account.

func (*Client) ListInvitations

func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInput, optFns ...func(*Options)) (*ListInvitationsOutput, error)

Retrieves information about the Amazon Macie membership invitations that were received by an account.

func (*Client) ListManagedDataIdentifiers

func (c *Client) ListManagedDataIdentifiers(ctx context.Context, params *ListManagedDataIdentifiersInput, optFns ...func(*Options)) (*ListManagedDataIdentifiersOutput, error)

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

func (*Client) ListMembers

func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error)

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

func (*Client) ListOrganizationAdminAccounts

func (c *Client) ListOrganizationAdminAccounts(ctx context.Context, params *ListOrganizationAdminAccountsInput, optFns ...func(*Options)) (*ListOrganizationAdminAccountsOutput, error)

Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

func (*Client) PutClassificationExportConfiguration

func (c *Client) PutClassificationExportConfiguration(ctx context.Context, params *PutClassificationExportConfigurationInput, optFns ...func(*Options)) (*PutClassificationExportConfigurationOutput, error)

Creates or updates the configuration settings for storing data classification results.

func (*Client) PutFindingsPublicationConfiguration

func (c *Client) PutFindingsPublicationConfiguration(ctx context.Context, params *PutFindingsPublicationConfigurationInput, optFns ...func(*Options)) (*PutFindingsPublicationConfigurationOutput, error)

Updates the configuration settings for publishing findings to Security Hub.

func (*Client) SearchResources

func (c *Client) SearchResources(ctx context.Context, params *SearchResourcesInput, optFns ...func(*Options)) (*SearchResourcesOutput, error)

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

func (*Client) TestCustomDataIdentifier

func (c *Client) TestCustomDataIdentifier(ctx context.Context, params *TestCustomDataIdentifierInput, optFns ...func(*Options)) (*TestCustomDataIdentifierOutput, error)

Tests a custom data identifier.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

func (*Client) UpdateClassificationJob

func (c *Client) UpdateClassificationJob(ctx context.Context, params *UpdateClassificationJobInput, optFns ...func(*Options)) (*UpdateClassificationJobOutput, error)

Changes the status of a classification job.

func (*Client) UpdateFindingsFilter

func (c *Client) UpdateFindingsFilter(ctx context.Context, params *UpdateFindingsFilterInput, optFns ...func(*Options)) (*UpdateFindingsFilterOutput, error)

Updates the criteria and other settings for a findings filter.

func (*Client) UpdateMacieSession

func (c *Client) UpdateMacieSession(ctx context.Context, params *UpdateMacieSessionInput, optFns ...func(*Options)) (*UpdateMacieSessionOutput, error)

Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.

func (*Client) UpdateMemberSession

func (c *Client) UpdateMemberSession(ctx context.Context, params *UpdateMemberSessionInput, optFns ...func(*Options)) (*UpdateMemberSessionOutput, error)

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

func (*Client) UpdateOrganizationConfiguration

func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *UpdateOrganizationConfigurationInput, optFns ...func(*Options)) (*UpdateOrganizationConfigurationOutput, error)

Updates the Amazon Macie configuration settings for an organization in Organizations.

type CreateClassificationJobInput

type CreateClassificationJobInput struct {

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	//
	// This member is required.
	ClientToken *string

	// The schedule for running the job. Valid values are:
	//
	// * ONE_TIME - Run the job
	// only once. If you specify this value, don't specify a value for the
	// scheduleFrequency property.
	//
	// * SCHEDULED - Run the job on a daily, weekly, or
	// monthly basis. If you specify this value, use the scheduleFrequency property to
	// define the recurrence pattern for the job.
	//
	// This member is required.
	JobType types.JobType

	// A custom name for the job. The name can contain as many as 500 characters.
	//
	// This member is required.
	Name *string

	// The S3 buckets that contain the objects to analyze, and the scope of that
	// analysis.
	//
	// This member is required.
	S3JobDefinition *types.S3JobDefinition

	// An array of unique identifiers, one for each custom data identifier for the job
	// to use when it analyzes data. To use only managed data identifiers, don't
	// specify a value for this property and specify a value other than NONE for the
	// managedDataIdentifierSelector property.
	CustomDataIdentifierIds []string

	// A custom description of the job. The description can contain as many as 200
	// characters.
	Description *string

	// For a recurring job, specifies whether to analyze all existing, eligible objects
	// immediately after the job is created (true). To analyze only those objects that
	// are created or changed after you create the job and before the job's first
	// scheduled run, set this value to false.If you configure the job to run only
	// once, don't specify a value for this property.
	InitialRun bool

	// An array of unique identifiers, one for each managed data identifier for the job
	// to include (use) or exclude (not use) when it analyzes data. Inclusion or
	// exclusion depends on the managed data identifier selection type that you specify
	// for the job (managedDataIdentifierSelector).To retrieve a list of valid values
	// for this property, use the ListManagedDataIdentifiers operation.
	ManagedDataIdentifierIds []string

	// The selection type to apply when determining which managed data identifiers the
	// job uses to analyze data. Valid values are:
	//
	// * ALL - Use all the managed data
	// identifiers that Amazon Macie provides. If you specify this value, don't specify
	// any values for the managedDataIdentifierIds property.
	//
	// * EXCLUDE - Use all the
	// managed data identifiers that Macie provides except the managed data identifiers
	// specified by the managedDataIdentifierIds property.
	//
	// * INCLUDE - Use only the
	// managed data identifiers specified by the managedDataIdentifierIds property.
	//
	// *
	// NONE - Don't use any managed data identifiers. If you specify this value,
	// specify at least one custom data identifier for the job
	// (customDataIdentifierIds) and don't specify any values for the
	// managedDataIdentifierIds property.
	//
	// If you don't specify a value for this
	// property, the job uses all managed data identifiers. If you don't specify a
	// value for this property or you specify ALL or EXCLUDE for a recurring job, the
	// job also uses new managed data identifiers as they are released.
	ManagedDataIdentifierSelector types.ManagedDataIdentifierSelector

	// The sampling depth, as a percentage, for the job to apply when processing
	// objects. This value determines the percentage of eligible objects that the job
	// analyzes. If this value is less than 100, Amazon Macie selects the objects to
	// analyze at random, up to the specified percentage, and analyzes all the data in
	// those objects.
	SamplingPercentage int32

	// The recurrence pattern for running the job. To run the job only once, don't
	// specify a value for this property and set the value for the jobType property to
	// ONE_TIME.
	ScheduleFrequency *types.JobScheduleFrequency

	// A map of key-value pairs that specifies the tags to associate with the job. A
	// job can have a maximum of 50 tags. Each tag consists of a tag key and an
	// associated tag value. The maximum length of a tag key is 128 characters. The
	// maximum length of a tag value is 256 characters.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateClassificationJobOutput

type CreateClassificationJobOutput struct {

	// The Amazon Resource Name (ARN) of the job.
	JobArn *string

	// The unique identifier for the job.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomDataIdentifierInput

type CreateCustomDataIdentifierInput struct {

	// A custom name for the custom data identifier. The name can contain as many as
	// 128 characters. We strongly recommend that you avoid including any sensitive
	// data in the name of a custom data identifier. Other users of your account might
	// be able to see this name, depending on the actions that they're allowed to
	// perform in Amazon Macie.
	//
	// This member is required.
	Name *string

	// The regular expression (regex) that defines the pattern to match. The expression
	// can contain as many as 512 characters.
	//
	// This member is required.
	Regex *string

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	ClientToken *string

	// A custom description of the custom data identifier. The description can contain
	// as many as 512 characters. We strongly recommend that you avoid including any
	// sensitive data in the description of a custom data identifier. Other users of
	// your account might be able to see this description, depending on the actions
	// that they're allowed to perform in Amazon Macie.
	Description *string

	// An array that lists specific character sequences (ignore words) to exclude from
	// the results. If the text matched by the regular expression contains any string
	// in this array, Amazon Macie ignores it. The array can contain as many as 10
	// ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words
	// are case sensitive.
	IgnoreWords []string

	// An array that lists specific character sequences (keywords), one of which must
	// be within proximity (maximumMatchDistance) of the regular expression to match.
	// The array can contain as many as 50 keywords. Each keyword can contain 3-90
	// UTF-8 characters. Keywords aren't case sensitive.
	Keywords []string

	// The maximum number of characters that can exist between text that matches the
	// regular expression and the character sequences specified by the keywords array.
	// Amazon Macie includes or excludes a result based on the proximity of a keyword
	// to text that matches the regular expression. The distance can be 1-300
	// characters. The default value is 50.
	MaximumMatchDistance int32

	// The severity to assign to findings that the custom data identifier produces,
	// based on the number of occurrences of text that matches the custom data
	// identifier's detection criteria. You can specify as many as three SeverityLevel
	// objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you
	// specify more than one, the occurrences thresholds must be in ascending order by
	// severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and
	// 100 for HIGH. If an S3 object contains fewer occurrences than the lowest
	// specified threshold, Amazon Macie doesn't create a finding. If you don't specify
	// any values for this array, Macie creates findings for S3 objects that contain at
	// least one occurrence of text that matches the detection criteria, and Macie
	// assigns the MEDIUM severity to those findings.
	SeverityLevels []types.SeverityLevel

	// A map of key-value pairs that specifies the tags to associate with the custom
	// data identifier. A custom data identifier can have a maximum of 50 tags. Each
	// tag consists of a tag key and an associated tag value. The maximum length of a
	// tag key is 128 characters. The maximum length of a tag value is 256 characters.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateCustomDataIdentifierOutput

type CreateCustomDataIdentifierOutput struct {

	// The unique identifier for the custom data identifier that was created.
	CustomDataIdentifierId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFindingsFilterInput

type CreateFindingsFilterInput struct {

	// The action to perform on findings that meet the filter criteria
	// (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive)
	// the findings; and, NOOP, don't perform any action on the findings.
	//
	// This member is required.
	Action types.FindingsFilterAction

	// The criteria to use to filter findings.
	//
	// This member is required.
	FindingCriteria *types.FindingCriteria

	// A custom name for the filter. The name must contain at least 3 characters and
	// can contain as many as 64 characters. We strongly recommend that you avoid
	// including any sensitive data in the name of a filter. Other users of your
	// account might be able to see this name, depending on the actions that they're
	// allowed to perform in Amazon Macie.
	//
	// This member is required.
	Name *string

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	ClientToken *string

	// A custom description of the filter. The description can contain as many as 512
	// characters. We strongly recommend that you avoid including any sensitive data in
	// the description of a filter. Other users of your account might be able to see
	// this description, depending on the actions that they're allowed to perform in
	// Amazon Macie.
	Description *string

	// The position of the filter in the list of saved filters on the Amazon Macie
	// console. This value also determines the order in which the filter is applied to
	// findings, relative to other filters that are also applied to the findings.
	Position int32

	// A map of key-value pairs that specifies the tags to associate with the filter. A
	// findings filter can have a maximum of 50 tags. Each tag consists of a tag key
	// and an associated tag value. The maximum length of a tag key is 128 characters.
	// The maximum length of a tag value is 256 characters.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFindingsFilterOutput

type CreateFindingsFilterOutput struct {

	// The Amazon Resource Name (ARN) of the filter that was created.
	Arn *string

	// The unique identifier for the filter that was created.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateInvitationsInput

type CreateInvitationsInput struct {

	// An array that lists Amazon Web Services account IDs, one for each account to
	// send the invitation to.
	//
	// This member is required.
	AccountIds []string

	// Specifies whether to send the invitation as an email message. If this value is
	// false, Amazon Macie sends the invitation (as an email message) to the email
	// address that you specified for the recipient's account when you associated the
	// account with your account. The default value is false.
	DisableEmailNotification bool

	// Custom text to include in the email message that contains the invitation. The
	// text can contain as many as 80 alphanumeric characters.
	Message *string
	// contains filtered or unexported fields
}

type CreateInvitationsOutput

type CreateInvitationsOutput struct {

	// An array of objects, one for each account whose invitation hasn't been
	// processed. Each object identifies the account and explains why the invitation
	// hasn't been processed for the account.
	UnprocessedAccounts []types.UnprocessedAccount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMemberInput

type CreateMemberInput struct {

	// The details of the account to associate with the administrator account.
	//
	// This member is required.
	Account *types.AccountDetail

	// A map of key-value pairs that specifies the tags to associate with the account
	// in Amazon Macie. An account can have a maximum of 50 tags. Each tag consists of
	// a tag key and an associated tag value. The maximum length of a tag key is 128
	// characters. The maximum length of a tag value is 256 characters.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateMemberOutput

type CreateMemberOutput struct {

	// The Amazon Resource Name (ARN) of the account that was associated with the
	// administrator account.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSampleFindingsInput

type CreateSampleFindingsInput struct {

	// An array of finding types, one for each type of sample finding to create. To
	// create a sample of every type of finding that Amazon Macie supports, don't
	// include this array in your request.
	FindingTypes []types.FindingType
	// contains filtered or unexported fields
}

type CreateSampleFindingsOutput

type CreateSampleFindingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeclineInvitationsInput

type DeclineInvitationsInput struct {

	// An array that lists Amazon Web Services account IDs, one for each account that
	// sent an invitation to decline.
	//
	// This member is required.
	AccountIds []string
	// contains filtered or unexported fields
}

type DeclineInvitationsOutput

type DeclineInvitationsOutput struct {

	// An array of objects, one for each account whose invitation hasn't been declined.
	// Each object identifies the account and explains why the request hasn't been
	// processed for that account.
	UnprocessedAccounts []types.UnprocessedAccount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomDataIdentifierInput

type DeleteCustomDataIdentifierInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteCustomDataIdentifierOutput

type DeleteCustomDataIdentifierOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFindingsFilterInput

type DeleteFindingsFilterInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteFindingsFilterOutput

type DeleteFindingsFilterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteInvitationsInput

type DeleteInvitationsInput struct {

	// An array that lists Amazon Web Services account IDs, one for each account that
	// sent an invitation to delete.
	//
	// This member is required.
	AccountIds []string
	// contains filtered or unexported fields
}

type DeleteInvitationsOutput

type DeleteInvitationsOutput struct {

	// An array of objects, one for each account whose invitation hasn't been deleted.
	// Each object identifies the account and explains why the request hasn't been
	// processed for that account.
	UnprocessedAccounts []types.UnprocessedAccount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMemberInput

type DeleteMemberInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteMemberOutput

type DeleteMemberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBucketsAPIClient

type DescribeBucketsAPIClient interface {
	DescribeBuckets(context.Context, *DescribeBucketsInput, ...func(*Options)) (*DescribeBucketsOutput, error)
}

DescribeBucketsAPIClient is a client that implements the DescribeBuckets operation.

type DescribeBucketsInput

type DescribeBucketsInput struct {

	// The criteria to use to filter the query results.
	Criteria map[string]types.BucketCriteriaAdditionalProperties

	// The maximum number of items to include in each page of the response. The default
	// value is 50.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string

	// The criteria to use to sort the query results.
	SortCriteria *types.BucketSortCriteria
	// contains filtered or unexported fields
}

type DescribeBucketsOutput

type DescribeBucketsOutput struct {

	// An array of objects, one for each bucket that meets the filter criteria
	// specified in the request.
	Buckets []types.BucketMetadata

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBucketsPaginator

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

DescribeBucketsPaginator is a paginator for DescribeBuckets

func NewDescribeBucketsPaginator

func NewDescribeBucketsPaginator(client DescribeBucketsAPIClient, params *DescribeBucketsInput, optFns ...func(*DescribeBucketsPaginatorOptions)) *DescribeBucketsPaginator

NewDescribeBucketsPaginator returns a new DescribeBucketsPaginator

func (*DescribeBucketsPaginator) HasMorePages

func (p *DescribeBucketsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeBucketsPaginator) NextPage

func (p *DescribeBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBucketsOutput, error)

NextPage retrieves the next DescribeBuckets page.

type DescribeBucketsPaginatorOptions

type DescribeBucketsPaginatorOptions struct {
	// The maximum number of items to include in each page of the response. The default
	// value is 50.
	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
}

DescribeBucketsPaginatorOptions is the paginator options for DescribeBuckets

type DescribeClassificationJobInput

type DescribeClassificationJobInput struct {

	// The unique identifier for the classification job.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeClassificationJobOutput

type DescribeClassificationJobOutput struct {

	// The token that was provided to ensure the idempotency of the request to create
	// the job.
	ClientToken *string

	// The date and time, in UTC and extended ISO 8601 format, when the job was
	// created.
	CreatedAt *time.Time

	// An array of unique identifiers, one for each custom data identifier that the job
	// uses to analyze data. This value is null if the job uses only managed data
	// identifiers to analyze data.
	CustomDataIdentifierIds []string

	// The custom description of the job.
	Description *string

	// For a recurring job, specifies whether you configured the job to analyze all
	// existing, eligible objects immediately after the job was created (true). If you
	// configured the job to analyze only those objects that were created or changed
	// after the job was created and before the job's first scheduled run, this value
	// is false. This value is also false for a one-time job.
	InitialRun bool

	// The Amazon Resource Name (ARN) of the job.
	JobArn *string

	// The unique identifier for the job.
	JobId *string

	// The current status of the job. Possible values are:
	//
	// * CANCELLED - You cancelled
	// the job or, if it's a one-time job, you paused the job and didn't resume it
	// within 30 days.
	//
	// * COMPLETE - For a one-time job, Amazon Macie finished
	// processing the data specified for the job. This value doesn't apply to recurring
	// jobs.
	//
	// * IDLE - For a recurring job, the previous scheduled run is complete and
	// the next scheduled run is pending. This value doesn't apply to one-time jobs.
	//
	// *
	// PAUSED - Macie started running the job but additional processing would exceed
	// the monthly sensitive data discovery quota for your account or one or more
	// member accounts that the job analyzes data for.
	//
	// * RUNNING - For a one-time job,
	// the job is in progress. For a recurring job, a scheduled run is in progress.
	//
	// *
	// USER_PAUSED - You paused the job. If you paused the job while it had a status of
	// RUNNING and you don't resume it within 30 days of pausing it, the job or job run
	// will expire and be cancelled, depending on the job's type. To check the
	// expiration date, refer to the UserPausedDetails.jobExpiresAt property.
	JobStatus types.JobStatus

	// The schedule for running the job. Possible values are:
	//
	// * ONE_TIME - The job
	// runs only once.
	//
	// * SCHEDULED - The job runs on a daily, weekly, or monthly
	// basis. The scheduleFrequency property indicates the recurrence pattern for the
	// job.
	JobType types.JobType

	// Specifies whether any account- or bucket-level access errors occurred when the
	// job ran. For a recurring job, this value indicates the error status of the job's
	// most recent run.
	LastRunErrorStatus *types.LastRunErrorStatus

	// The date and time, in UTC and extended ISO 8601 format, when the job started. If
	// the job is a recurring job, this value indicates when the most recent run
	// started.
	LastRunTime *time.Time

	// An array of unique identifiers, one for each managed data identifier that the
	// job is explicitly configured to include (use) or exclude (not use) when it
	// analyzes data. Inclusion or exclusion depends on the managed data identifier
	// selection type specified for the job (managedDataIdentifierSelector). This value
	// is null if the job's managed data identifier selection type is ALL or the job
	// uses only custom data identifiers (customDataIdentifierIds) to analyze data.
	ManagedDataIdentifierIds []string

	// The selection type that determines which managed data identifiers the job uses
	// to analyze data. Possible values are:
	//
	// * ALL - Use all the managed data
	// identifiers that Amazon Macie provides.
	//
	// * EXCLUDE - Use all the managed data
	// identifiers that Macie provides except the managed data identifiers specified by
	// the managedDataIdentifierIds property.
	//
	// * INCLUDE - Use only the managed data
	// identifiers specified by the managedDataIdentifierIds property.
	//
	// * NONE - Don't
	// use any managed data identifiers.
	//
	// If this value is null, the job uses all
	// managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring
	// job, the job also uses new managed data identifiers as they are released.
	ManagedDataIdentifierSelector types.ManagedDataIdentifierSelector

	// The custom name of the job.
	Name *string

	// The S3 buckets that contain the objects to analyze, and the scope of that
	// analysis.
	S3JobDefinition *types.S3JobDefinition

	// The sampling depth, as a percentage, that determines the percentage of eligible
	// objects that the job analyzes.
	SamplingPercentage int32

	// The recurrence pattern for running the job. This value is null if the job is
	// configured to run only once.
	ScheduleFrequency *types.JobScheduleFrequency

	// The number of times that the job has run and processing statistics for the job's
	// current run.
	Statistics *types.Statistics

	// A map of key-value pairs that specifies which tags (keys and values) are
	// associated with the classification job.
	Tags map[string]string

	// If the current status of the job is USER_PAUSED, specifies when the job was
	// paused and when the job or job run will expire and be cancelled if it isn't
	// resumed. This value is present only if the value for jobStatus is USER_PAUSED.
	UserPausedDetails *types.UserPausedDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeOrganizationConfigurationInput

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

type DescribeOrganizationConfigurationOutput

type DescribeOrganizationConfigurationOutput struct {

	// Specifies whether Amazon Macie is enabled automatically for accounts that are
	// added to the organization.
	AutoEnable bool

	// Specifies whether the maximum number of Amazon Macie member accounts are part of
	// the organization.
	MaxAccountLimitReached bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableMacieInput

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

type DisableMacieOutput

type DisableMacieOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableOrganizationAdminAccountInput

type DisableOrganizationAdminAccountInput struct {

	// The Amazon Web Services account ID of the delegated Amazon Macie administrator
	// account.
	//
	// This member is required.
	AdminAccountId *string
	// contains filtered or unexported fields
}

type DisableOrganizationAdminAccountOutput

type DisableOrganizationAdminAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateFromAdministratorAccountInput

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

type DisassociateFromAdministratorAccountOutput

type DisassociateFromAdministratorAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateFromMasterAccountInput

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

type DisassociateFromMasterAccountOutput

type DisassociateFromMasterAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateMemberInput

type DisassociateMemberInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DisassociateMemberOutput

type DisassociateMemberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableMacieInput

type EnableMacieInput struct {

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	ClientToken *string

	// Specifies how often to publish updates to policy findings for the account. This
	// includes publishing updates to Security Hub and Amazon EventBridge (formerly
	// called Amazon CloudWatch Events).
	FindingPublishingFrequency types.FindingPublishingFrequency

	// Specifies the new status for the account. To enable Amazon Macie and start all
	// Macie activities for the account, set this value to ENABLED.
	Status types.MacieStatus
	// contains filtered or unexported fields
}

type EnableMacieOutput

type EnableMacieOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableOrganizationAdminAccountInput

type EnableOrganizationAdminAccountInput struct {

	// The Amazon Web Services account ID for the account to designate as the delegated
	// Amazon Macie administrator account for the organization.
	//
	// This member is required.
	AdminAccountId *string

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	ClientToken *string
	// contains filtered or unexported fields
}

type EnableOrganizationAdminAccountOutput

type EnableOrganizationAdminAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 GetAdministratorAccountInput

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

type GetAdministratorAccountOutput

type GetAdministratorAccountOutput struct {

	// The Amazon Web Services account ID for the administrator account. If the
	// accounts are associated by an Amazon Macie membership invitation, this object
	// also provides details about the invitation that was sent to establish the
	// relationship between the accounts.
	Administrator *types.Invitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetBucketStatisticsInput

type GetBucketStatisticsInput struct {

	// The unique identifier for the Amazon Web Services account.
	AccountId *string
	// contains filtered or unexported fields
}

type GetBucketStatisticsOutput

type GetBucketStatisticsOutput struct {

	// The total number of buckets.
	BucketCount int64

	// The total number of buckets that are publicly accessible based on a combination
	// of permissions settings for each bucket.
	BucketCountByEffectivePermission *types.BucketCountByEffectivePermission

	// The total number of buckets that use certain types of server-side encryption to
	// encrypt new objects by default. This object also reports the total number of
	// buckets that don't encrypt new objects by default.
	BucketCountByEncryptionType *types.BucketCountByEncryptionType

	// The total number of buckets whose bucket policies do or don't require
	// server-side encryption of objects when objects are uploaded to the buckets.
	BucketCountByObjectEncryptionRequirement *types.BucketCountPolicyAllowsUnencryptedObjectUploads

	// The total number of buckets that are or aren't shared with another Amazon Web
	// Services account.
	BucketCountBySharedAccessType *types.BucketCountBySharedAccessType

	// The total number of objects that Amazon Macie can analyze in the buckets. These
	// objects use a supported storage class and have a file name extension for a
	// supported file or storage format.
	ClassifiableObjectCount int64

	// The total storage size, in bytes, of all the objects that Amazon Macie can
	// analyze in the buckets. These objects use a supported storage class and have a
	// file name extension for a supported file or storage format. If versioning is
	// enabled for any of the buckets, Macie calculates this value based on the size of
	// the latest version of each applicable object in those buckets. This value
	// doesn't reflect the storage size of all versions of all applicable objects in
	// the buckets.
	ClassifiableSizeInBytes int64

	// The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most
	// recently retrieved both bucket and object metadata from Amazon S3 for the
	// buckets.
	LastUpdated *time.Time

	// The total number of objects in the buckets.
	ObjectCount int64

	// The total storage size, in bytes, of the buckets. If versioning is enabled for
	// any of the buckets, Amazon Macie calculates this value based on the size of the
	// latest version of each object in those buckets. This value doesn't reflect the
	// storage size of all versions of the objects in the buckets.
	SizeInBytes int64

	// The total storage size, in bytes, of the objects that are compressed (.gz,
	// .gzip, .zip) files in the buckets. If versioning is enabled for any of the
	// buckets, Amazon Macie calculates this value based on the size of the latest
	// version of each applicable object in those buckets. This value doesn't reflect
	// the storage size of all versions of the applicable objects in the buckets.
	SizeInBytesCompressed int64

	// The total number of objects that Amazon Macie can't analyze in the buckets.
	// These objects don't use a supported storage class or don't have a file name
	// extension for a supported file or storage format.
	UnclassifiableObjectCount *types.ObjectLevelStatistics

	// The total storage size, in bytes, of the objects that Amazon Macie can't analyze
	// in the buckets. These objects don't use a supported storage class or don't have
	// a file name extension for a supported file or storage format.
	UnclassifiableObjectSizeInBytes *types.ObjectLevelStatistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetClassificationExportConfigurationInput

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

type GetClassificationExportConfigurationOutput

type GetClassificationExportConfigurationOutput struct {

	// The location where data classification results are stored, and the encryption
	// settings that are used when storing results in that location.
	Configuration *types.ClassificationExportConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCustomDataIdentifierInput

type GetCustomDataIdentifierInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetCustomDataIdentifierOutput

type GetCustomDataIdentifierOutput struct {

	// The Amazon Resource Name (ARN) of the custom data identifier.
	Arn *string

	// The date and time, in UTC and extended ISO 8601 format, when the custom data
	// identifier was created.
	CreatedAt *time.Time

	// Specifies whether the custom data identifier was deleted. If you delete a custom
	// data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft
	// deletes the identifier.
	Deleted bool

	// The custom description of the custom data identifier.
	Description *string

	// The unique identifier for the custom data identifier.
	Id *string

	// An array that lists specific character sequences (ignore words) to exclude from
	// the results. If the text matched by the regular expression contains any string
	// in this array, Amazon Macie ignores it. Ignore words are case sensitive.
	IgnoreWords []string

	// An array that lists specific character sequences (keywords), one of which must
	// be within proximity (maximumMatchDistance) of the regular expression to match.
	// Keywords aren't case sensitive.
	Keywords []string

	// The maximum number of characters that can exist between text that matches the
	// regular expression and the character sequences specified by the keywords array.
	// Amazon Macie includes or excludes a result based on the proximity of a keyword
	// to text that matches the regular expression.
	MaximumMatchDistance int32

	// The custom name of the custom data identifier.
	Name *string

	// The regular expression (regex) that defines the pattern to match.
	Regex *string

	// Specifies the severity that's assigned to findings that the custom data
	// identifier produces, based on the number of occurrences of text that matches the
	// custom data identifier's detection criteria. By default, Amazon Macie creates
	// findings for S3 objects that contain at least one occurrence of text that
	// matches the detection criteria, and Macie assigns the MEDIUM severity to those
	// findings.
	SeverityLevels []types.SeverityLevel

	// A map of key-value pairs that identifies the tags (keys and values) that are
	// associated with the custom data identifier.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFindingStatisticsInput

type GetFindingStatisticsInput struct {

	// The finding property to use to group the query results. Valid values are:
	//
	// *
	// classificationDetails.jobId - The unique identifier for the classification job
	// that produced the finding.
	//
	// * resourcesAffected.s3Bucket.name - The name of the
	// S3 bucket that the finding applies to.
	//
	// * severity.description - The severity
	// level of the finding, such as High or Medium.
	//
	// * type - The type of finding,
	// such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.
	//
	// This member is required.
	GroupBy types.GroupBy

	// The criteria to use to filter the query results.
	FindingCriteria *types.FindingCriteria

	// The maximum number of items to include in each page of the response.
	Size int32

	// The criteria to use to sort the query results.
	SortCriteria *types.FindingStatisticsSortCriteria
	// contains filtered or unexported fields
}

type GetFindingStatisticsOutput

type GetFindingStatisticsOutput struct {

	// An array of objects, one for each group of findings that meet the filter
	// criteria specified in the request.
	CountsByGroup []types.GroupCount

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFindingsFilterInput

type GetFindingsFilterInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetFindingsFilterOutput

type GetFindingsFilterOutput struct {

	// The action that's performed on findings that meet the filter criteria
	// (findingCriteria). Possible values are: ARCHIVE, suppress (automatically
	// archive) the findings; and, NOOP, don't perform any action on the findings.
	Action types.FindingsFilterAction

	// The Amazon Resource Name (ARN) of the filter.
	Arn *string

	// The custom description of the filter.
	Description *string

	// The criteria that's used to filter findings.
	FindingCriteria *types.FindingCriteria

	// The unique identifier for the filter.
	Id *string

	// The custom name of the filter.
	Name *string

	// The position of the filter in the list of saved filters on the Amazon Macie
	// console. This value also determines the order in which the filter is applied to
	// findings, relative to other filters that are also applied to the findings.
	Position int32

	// A map of key-value pairs that identifies the tags (keys and values) that are
	// associated with the filter.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFindingsInput

type GetFindingsInput struct {

	// An array of strings that lists the unique identifiers for the findings to
	// retrieve.
	//
	// This member is required.
	FindingIds []string

	// The criteria for sorting the results of the request.
	SortCriteria *types.SortCriteria
	// contains filtered or unexported fields
}

type GetFindingsOutput

type GetFindingsOutput struct {

	// An array of objects, one for each finding that meets the criteria specified in
	// the request.
	Findings []types.Finding

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFindingsPublicationConfigurationInput

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

type GetFindingsPublicationConfigurationOutput

type GetFindingsPublicationConfigurationOutput struct {

	// The configuration settings that determine which findings are published to
	// Security Hub.
	SecurityHubConfiguration *types.SecurityHubConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInvitationsCountInput

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

type GetInvitationsCountOutput

type GetInvitationsCountOutput struct {

	// The total number of invitations that were received by the account, not including
	// the currently accepted invitation.
	InvitationsCount int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMacieSessionInput

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

type GetMacieSessionOutput

type GetMacieSessionOutput struct {

	// The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie
	// account was created.
	CreatedAt *time.Time

	// The frequency with which Amazon Macie publishes updates to policy findings for
	// the account. This includes publishing updates to Security Hub and Amazon
	// EventBridge (formerly called Amazon CloudWatch Events).
	FindingPublishingFrequency types.FindingPublishingFrequency

	// The Amazon Resource Name (ARN) of the service-linked role that allows Amazon
	// Macie to monitor and analyze data in Amazon Web Services resources for the
	// account.
	ServiceRole *string

	// The current status of the Amazon Macie account. Possible values are: PAUSED, the
	// account is enabled but all Macie activities are suspended (paused) for the
	// account; and, ENABLED, the account is enabled and all Macie activities are
	// enabled for the account.
	Status types.MacieStatus

	// The date and time, in UTC and extended ISO 8601 format, of the most recent
	// change to the status of the Amazon Macie account.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMasterAccountInput

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

type GetMasterAccountOutput

type GetMasterAccountOutput struct {

	// (Deprecated) The Amazon Web Services account ID for the administrator account.
	// If the accounts are associated by a Macie membership invitation, this object
	// also provides details about the invitation that was sent to establish the
	// relationship between the accounts.
	Master *types.Invitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMemberInput

type GetMemberInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetMemberOutput

type GetMemberOutput struct {

	// The Amazon Web Services account ID for the account.
	AccountId *string

	// The Amazon Web Services account ID for the administrator account.
	AdministratorAccountId *string

	// The Amazon Resource Name (ARN) of the account.
	Arn *string

	// The email address for the account.
	Email *string

	// The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie
	// membership invitation was last sent to the account. This value is null if an
	// invitation hasn't been sent to the account.
	InvitedAt *time.Time

	// (Deprecated) The Amazon Web Services account ID for the administrator account.
	// This property has been replaced by the administratorAccountId property and is
	// retained only for backward compatibility.
	MasterAccountId *string

	// The current status of the relationship between the account and the administrator
	// account.
	RelationshipStatus types.RelationshipStatus

	// A map of key-value pairs that identifies the tags (keys and values) that are
	// associated with the member account in Amazon Macie.
	Tags map[string]string

	// The date and time, in UTC and extended ISO 8601 format, of the most recent
	// change to the status of the relationship between the account and the
	// administrator account.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetUsageStatisticsAPIClient

type GetUsageStatisticsAPIClient interface {
	GetUsageStatistics(context.Context, *GetUsageStatisticsInput, ...func(*Options)) (*GetUsageStatisticsOutput, error)
}

GetUsageStatisticsAPIClient is a client that implements the GetUsageStatistics operation.

type GetUsageStatisticsInput

type GetUsageStatisticsInput struct {

	// An array of objects, one for each condition to use to filter the query results.
	// If you specify more than one condition, Amazon Macie uses an AND operator to
	// join the conditions.
	FilterBy []types.UsageStatisticsFilter

	// The maximum number of items to include in each page of the response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string

	// The criteria to use to sort the query results.
	SortBy *types.UsageStatisticsSortBy

	// The inclusive time period to query usage data for. Valid values are:
	// MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for
	// the preceding 30 days. If you don't specify a value, Amazon Macie provides usage
	// data for the preceding 30 days.
	TimeRange types.TimeRange
	// contains filtered or unexported fields
}

type GetUsageStatisticsOutput

type GetUsageStatisticsOutput struct {

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// An array of objects that contains the results of the query. Each object contains
	// the data for an account that meets the filter criteria specified in the request.
	Records []types.UsageRecord

	// The inclusive time period that the usage data applies to. Possible values are:
	// MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for
	// the preceding 30 days.
	TimeRange types.TimeRange

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetUsageStatisticsPaginator

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

GetUsageStatisticsPaginator is a paginator for GetUsageStatistics

func NewGetUsageStatisticsPaginator

func NewGetUsageStatisticsPaginator(client GetUsageStatisticsAPIClient, params *GetUsageStatisticsInput, optFns ...func(*GetUsageStatisticsPaginatorOptions)) *GetUsageStatisticsPaginator

NewGetUsageStatisticsPaginator returns a new GetUsageStatisticsPaginator

func (*GetUsageStatisticsPaginator) HasMorePages

func (p *GetUsageStatisticsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetUsageStatisticsPaginator) NextPage

func (p *GetUsageStatisticsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetUsageStatisticsOutput, error)

NextPage retrieves the next GetUsageStatistics page.

type GetUsageStatisticsPaginatorOptions

type GetUsageStatisticsPaginatorOptions struct {
	// The maximum number of items to include in each page of 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
}

GetUsageStatisticsPaginatorOptions is the paginator options for GetUsageStatistics

type GetUsageTotalsInput

type GetUsageTotalsInput struct {

	// The inclusive time period to retrieve the data for. Valid values are:
	// MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for
	// the preceding 30 days. If you don't specify a value for this parameter, Amazon
	// Macie provides aggregated usage data for the preceding 30 days.
	TimeRange *string
	// contains filtered or unexported fields
}

type GetUsageTotalsOutput

type GetUsageTotalsOutput struct {

	// The inclusive time period that the usage data applies to. Possible values are:
	// MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for
	// the preceding 30 days.
	TimeRange types.TimeRange

	// An array of objects that contains the results of the query. Each object contains
	// the data for a specific usage metric.
	UsageTotals []types.UsageTotal

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

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

type HTTPSignerV4

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

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListClassificationJobsAPIClient

type ListClassificationJobsAPIClient interface {
	ListClassificationJobs(context.Context, *ListClassificationJobsInput, ...func(*Options)) (*ListClassificationJobsOutput, error)
}

ListClassificationJobsAPIClient is a client that implements the ListClassificationJobs operation.

type ListClassificationJobsInput

type ListClassificationJobsInput struct {

	// The criteria to use to filter the results.
	FilterCriteria *types.ListJobsFilterCriteria

	// The maximum number of items to include in each page of the response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string

	// The criteria to use to sort the results.
	SortCriteria *types.ListJobsSortCriteria
	// contains filtered or unexported fields
}

type ListClassificationJobsOutput

type ListClassificationJobsOutput struct {

	// An array of objects, one for each job that meets the filter criteria specified
	// in the request.
	Items []types.JobSummary

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListClassificationJobsPaginator

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

ListClassificationJobsPaginator is a paginator for ListClassificationJobs

func NewListClassificationJobsPaginator

NewListClassificationJobsPaginator returns a new ListClassificationJobsPaginator

func (*ListClassificationJobsPaginator) HasMorePages

func (p *ListClassificationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListClassificationJobsPaginator) NextPage

NextPage retrieves the next ListClassificationJobs page.

type ListClassificationJobsPaginatorOptions

type ListClassificationJobsPaginatorOptions struct {
	// The maximum number of items to include in each page of 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
}

ListClassificationJobsPaginatorOptions is the paginator options for ListClassificationJobs

type ListCustomDataIdentifiersAPIClient

type ListCustomDataIdentifiersAPIClient interface {
	ListCustomDataIdentifiers(context.Context, *ListCustomDataIdentifiersInput, ...func(*Options)) (*ListCustomDataIdentifiersOutput, error)
}

ListCustomDataIdentifiersAPIClient is a client that implements the ListCustomDataIdentifiers operation.

type ListCustomDataIdentifiersInput

type ListCustomDataIdentifiersInput struct {

	// The maximum number of items to include in each page of the response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomDataIdentifiersOutput

type ListCustomDataIdentifiersOutput struct {

	// An array of objects, one for each custom data identifier.
	Items []types.CustomDataIdentifierSummary

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomDataIdentifiersPaginator

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

ListCustomDataIdentifiersPaginator is a paginator for ListCustomDataIdentifiers

func NewListCustomDataIdentifiersPaginator

NewListCustomDataIdentifiersPaginator returns a new ListCustomDataIdentifiersPaginator

func (*ListCustomDataIdentifiersPaginator) HasMorePages

func (p *ListCustomDataIdentifiersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomDataIdentifiersPaginator) NextPage

NextPage retrieves the next ListCustomDataIdentifiers page.

type ListCustomDataIdentifiersPaginatorOptions

type ListCustomDataIdentifiersPaginatorOptions struct {
	// The maximum number of items to include in each page of 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
}

ListCustomDataIdentifiersPaginatorOptions is the paginator options for ListCustomDataIdentifiers

type ListFindingsAPIClient

type ListFindingsAPIClient interface {
	ListFindings(context.Context, *ListFindingsInput, ...func(*Options)) (*ListFindingsOutput, error)
}

ListFindingsAPIClient is a client that implements the ListFindings operation.

type ListFindingsFiltersAPIClient

type ListFindingsFiltersAPIClient interface {
	ListFindingsFilters(context.Context, *ListFindingsFiltersInput, ...func(*Options)) (*ListFindingsFiltersOutput, error)
}

ListFindingsFiltersAPIClient is a client that implements the ListFindingsFilters operation.

type ListFindingsFiltersInput

type ListFindingsFiltersInput struct {

	// The maximum number of items to include in each page of a paginated response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFindingsFiltersOutput

type ListFindingsFiltersOutput struct {

	// An array of objects, one for each filter that's associated with the account.
	FindingsFilterListItems []types.FindingsFilterListItem

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFindingsFiltersPaginator

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

ListFindingsFiltersPaginator is a paginator for ListFindingsFilters

func NewListFindingsFiltersPaginator

func NewListFindingsFiltersPaginator(client ListFindingsFiltersAPIClient, params *ListFindingsFiltersInput, optFns ...func(*ListFindingsFiltersPaginatorOptions)) *ListFindingsFiltersPaginator

NewListFindingsFiltersPaginator returns a new ListFindingsFiltersPaginator

func (*ListFindingsFiltersPaginator) HasMorePages

func (p *ListFindingsFiltersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFindingsFiltersPaginator) NextPage

func (p *ListFindingsFiltersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFindingsFiltersOutput, error)

NextPage retrieves the next ListFindingsFilters page.

type ListFindingsFiltersPaginatorOptions

type ListFindingsFiltersPaginatorOptions struct {
	// The maximum number of items to include in each page of a paginated 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
}

ListFindingsFiltersPaginatorOptions is the paginator options for ListFindingsFilters

type ListFindingsInput

type ListFindingsInput struct {

	// The criteria to use to filter the results.
	FindingCriteria *types.FindingCriteria

	// The maximum number of items to include in each page of the response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string

	// The criteria to use to sort the results.
	SortCriteria *types.SortCriteria
	// contains filtered or unexported fields
}

type ListFindingsOutput

type ListFindingsOutput struct {

	// An array of strings, where each string is the unique identifier for a finding
	// that meets the filter criteria specified in the request.
	FindingIds []string

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFindingsPaginator

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

ListFindingsPaginator is a paginator for ListFindings

func NewListFindingsPaginator

func NewListFindingsPaginator(client ListFindingsAPIClient, params *ListFindingsInput, optFns ...func(*ListFindingsPaginatorOptions)) *ListFindingsPaginator

NewListFindingsPaginator returns a new ListFindingsPaginator

func (*ListFindingsPaginator) HasMorePages

func (p *ListFindingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFindingsPaginator) NextPage

func (p *ListFindingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFindingsOutput, error)

NextPage retrieves the next ListFindings page.

type ListFindingsPaginatorOptions

type ListFindingsPaginatorOptions struct {
	// The maximum number of items to include in each page of 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
}

ListFindingsPaginatorOptions is the paginator options for ListFindings

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 include in each page of a paginated response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInvitationsOutput

type ListInvitationsOutput struct {

	// An array of objects, one for each invitation that was received by the account.
	Invitations []types.Invitation

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 include in each page of a paginated 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 ListManagedDataIdentifiersInput

type ListManagedDataIdentifiersInput struct {

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListManagedDataIdentifiersOutput

type ListManagedDataIdentifiersOutput struct {

	// An array of objects, one for each managed data identifier.
	Items []types.ManagedDataIdentifierSummary

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 include in each page of a paginated response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string

	// Specifies which accounts to include in the response, based on the status of an
	// account's relationship with the administrator account. By default, the response
	// includes only current member accounts. To include all accounts, set this value
	// to false.
	OnlyAssociated *string
	// contains filtered or unexported fields
}

type ListMembersOutput

type ListMembersOutput struct {

	// An array of objects, one for each account that's associated with the
	// administrator account and meets the criteria specified in the request.
	Members []types.Member

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 include in each page of a paginated 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 include in each page of a paginated response.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListOrganizationAdminAccountsOutput

type ListOrganizationAdminAccountsOutput struct {

	// An array of objects, one for each delegated Amazon Macie administrator account
	// for the organization. Only one of these accounts can have a status of ENABLED.
	AdminAccounts []types.AdminAccount

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListOrganizationAdminAccountsPaginator

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

ListOrganizationAdminAccountsPaginator is a paginator for ListOrganizationAdminAccounts

func NewListOrganizationAdminAccountsPaginator

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

NextPage retrieves the next ListOrganizationAdminAccounts page.

type ListOrganizationAdminAccountsPaginatorOptions

type ListOrganizationAdminAccountsPaginatorOptions struct {
	// The maximum number of items to include in each page of a paginated 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 Amazon Resource Name (ARN) of the classification job, custom data
	// identifier, findings filter, or member account.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// A map of key-value pairs that identifies the tags (keys and values) that are
	// associated with the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

type PutClassificationExportConfigurationInput

type PutClassificationExportConfigurationInput struct {

	// The location to store data classification results in, and the encryption
	// settings to use when storing results in that location.
	//
	// This member is required.
	Configuration *types.ClassificationExportConfiguration
	// contains filtered or unexported fields
}

type PutClassificationExportConfigurationOutput

type PutClassificationExportConfigurationOutput struct {

	// The location where the data classification results are stored, and the
	// encryption settings that are used when storing results in that location.
	Configuration *types.ClassificationExportConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutFindingsPublicationConfigurationInput

type PutFindingsPublicationConfigurationInput struct {

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	ClientToken *string

	// The configuration settings that determine which findings to publish to Security
	// Hub.
	SecurityHubConfiguration *types.SecurityHubConfiguration
	// contains filtered or unexported fields
}

type PutFindingsPublicationConfigurationOutput

type PutFindingsPublicationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type SearchResourcesAPIClient

type SearchResourcesAPIClient interface {
	SearchResources(context.Context, *SearchResourcesInput, ...func(*Options)) (*SearchResourcesOutput, error)
}

SearchResourcesAPIClient is a client that implements the SearchResources operation.

type SearchResourcesInput

type SearchResourcesInput struct {

	// The filter conditions that determine which S3 buckets to include or exclude from
	// the query results.
	BucketCriteria *types.SearchResourcesBucketCriteria

	// The maximum number of items to include in each page of the response. The default
	// value is 50.
	MaxResults int32

	// The nextToken string that specifies which page of results to return in a
	// paginated response.
	NextToken *string

	// The criteria to use to sort the results.
	SortCriteria *types.SearchResourcesSortCriteria
	// contains filtered or unexported fields
}

type SearchResourcesOutput

type SearchResourcesOutput struct {

	// An array of objects, one for each resource that meets the filter criteria
	// specified in the request.
	MatchingResources []types.MatchingResource

	// The string to use in a subsequent request to get the next page of results in a
	// paginated response. This value is null if there are no additional pages.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchResourcesPaginator

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

SearchResourcesPaginator is a paginator for SearchResources

func NewSearchResourcesPaginator

func NewSearchResourcesPaginator(client SearchResourcesAPIClient, params *SearchResourcesInput, optFns ...func(*SearchResourcesPaginatorOptions)) *SearchResourcesPaginator

NewSearchResourcesPaginator returns a new SearchResourcesPaginator

func (*SearchResourcesPaginator) HasMorePages

func (p *SearchResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchResourcesPaginator) NextPage

func (p *SearchResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchResourcesOutput, error)

NextPage retrieves the next SearchResources page.

type SearchResourcesPaginatorOptions

type SearchResourcesPaginatorOptions struct {
	// The maximum number of items to include in each page of the response. The default
	// value is 50.
	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
}

SearchResourcesPaginatorOptions is the paginator options for SearchResources

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the classification job, custom data
	// identifier, findings filter, or member account.
	//
	// This member is required.
	ResourceArn *string

	// A map of key-value pairs that specifies the tags to associate with the resource.
	// A resource can have a maximum of 50 tags. Each tag consists of a tag key and an
	// associated tag value. The maximum length of a tag key is 128 characters. The
	// maximum length of a tag value is 256 characters.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TestCustomDataIdentifierInput

type TestCustomDataIdentifierInput struct {

	// The regular expression (regex) that defines the pattern to match. The expression
	// can contain as many as 512 characters.
	//
	// This member is required.
	Regex *string

	// The sample text to inspect by using the custom data identifier. The text can
	// contain as many as 1,000 characters.
	//
	// This member is required.
	SampleText *string

	// An array that lists specific character sequences (ignore words) to exclude from
	// the results. If the text matched by the regular expression contains any string
	// in this array, Amazon Macie ignores it. The array can contain as many as 10
	// ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words
	// are case sensitive.
	IgnoreWords []string

	// An array that lists specific character sequences (keywords), one of which must
	// be within proximity (maximumMatchDistance) of the regular expression to match.
	// The array can contain as many as 50 keywords. Each keyword can contain 3-90
	// UTF-8 characters. Keywords aren't case sensitive.
	Keywords []string

	// The maximum number of characters that can exist between text that matches the
	// regular expression and the character sequences specified by the keywords array.
	// Amazon Macie includes or excludes a result based on the proximity of a keyword
	// to text that matches the regular expression. The distance can be 1-300
	// characters. The default value is 50.
	MaximumMatchDistance int32
	// contains filtered or unexported fields
}

type TestCustomDataIdentifierOutput

type TestCustomDataIdentifierOutput struct {

	// The number of occurrences of sample text that matched the criteria specified by
	// the custom data identifier.
	MatchCount int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the classification job, custom data
	// identifier, findings filter, or member account.
	//
	// This member is required.
	ResourceArn *string

	// The key of the tag to remove from the resource. To remove multiple tags, append
	// the tagKeys parameter and argument for each additional tag to remove, separated
	// by an ampersand (&).
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateClassificationJobInput

type UpdateClassificationJobInput struct {

	// The unique identifier for the classification job.
	//
	// This member is required.
	JobId *string

	// The new status for the job. Valid values are:
	//
	// * CANCELLED - Stops the job
	// permanently and cancels it. This value is valid only if the job's current status
	// is IDLE, PAUSED, RUNNING, or USER_PAUSED. If you specify this value and the
	// job's current status is RUNNING, Amazon Macie immediately begins to stop all
	// processing tasks for the job. You can't resume or restart a job after you cancel
	// it.
	//
	// * RUNNING - Resumes the job. This value is valid only if the job's current
	// status is USER_PAUSED. If you paused the job while it was actively running and
	// you specify this value less than 30 days after you paused the job, Macie
	// immediately resumes processing from the point where you paused the job.
	// Otherwise, Macie resumes the job according to the schedule and other settings
	// for the job.
	//
	// * USER_PAUSED - Pauses the job temporarily. This value is valid
	// only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify
	// this value and the job's current status is RUNNING, Macie immediately begins to
	// pause all processing tasks for the job. If you pause a one-time job and you
	// don't resume it within 30 days, the job expires and Macie cancels the job. If
	// you pause a recurring job when its status is RUNNING and you don't resume it
	// within 30 days, the job run expires and Macie cancels the run. To check the
	// expiration date, refer to the UserPausedDetails.jobExpiresAt property.
	//
	// This member is required.
	JobStatus types.JobStatus
	// contains filtered or unexported fields
}

type UpdateClassificationJobOutput

type UpdateClassificationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFindingsFilterInput

type UpdateFindingsFilterInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string

	// The action to perform on findings that meet the filter criteria
	// (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive)
	// the findings; and, NOOP, don't perform any action on the findings.
	Action types.FindingsFilterAction

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	ClientToken *string

	// A custom description of the filter. The description can contain as many as 512
	// characters. We strongly recommend that you avoid including any sensitive data in
	// the description of a filter. Other users might be able to see this description,
	// depending on the actions that they're allowed to perform in Amazon Macie.
	Description *string

	// The criteria to use to filter findings.
	FindingCriteria *types.FindingCriteria

	// A custom name for the filter. The name must contain at least 3 characters and
	// can contain as many as 64 characters. We strongly recommend that you avoid
	// including any sensitive data in the name of a filter. Other users might be able
	// to see this name, depending on the actions that they're allowed to perform in
	// Amazon Macie.
	Name *string

	// The position of the filter in the list of saved filters on the Amazon Macie
	// console. This value also determines the order in which the filter is applied to
	// findings, relative to other filters that are also applied to the findings.
	Position int32
	// contains filtered or unexported fields
}

type UpdateFindingsFilterOutput

type UpdateFindingsFilterOutput struct {

	// The Amazon Resource Name (ARN) of the filter that was updated.
	Arn *string

	// The unique identifier for the filter that was updated.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMacieSessionInput

type UpdateMacieSessionInput struct {

	// Specifies how often to publish updates to policy findings for the account. This
	// includes publishing updates to Security Hub and Amazon EventBridge (formerly
	// called Amazon CloudWatch Events).
	FindingPublishingFrequency types.FindingPublishingFrequency

	// Specifies a new status for the account. Valid values are: ENABLED, resume all
	// Amazon Macie activities for the account; and, PAUSED, suspend all Macie
	// activities for the account.
	Status types.MacieStatus
	// contains filtered or unexported fields
}

type UpdateMacieSessionOutput

type UpdateMacieSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMemberSessionInput

type UpdateMemberSessionInput struct {

	// The unique identifier for the Amazon Macie resource or account that the request
	// applies to.
	//
	// This member is required.
	Id *string

	// Specifies the new status for the account. Valid values are: ENABLED, resume all
	// Amazon Macie activities for the account; and, PAUSED, suspend all Macie
	// activities for the account.
	//
	// This member is required.
	Status types.MacieStatus
	// contains filtered or unexported fields
}

type UpdateMemberSessionOutput

type UpdateMemberSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateOrganizationConfigurationInput

type UpdateOrganizationConfigurationInput struct {

	// Specifies whether to enable Amazon Macie automatically for an account when the
	// account is added to the organization in Organizations.
	//
	// This member is required.
	AutoEnable bool
	// contains filtered or unexported fields
}

type UpdateOrganizationConfigurationOutput

type UpdateOrganizationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

api_client.go api_op_AcceptInvitation.go api_op_BatchGetCustomDataIdentifiers.go api_op_CreateClassificationJob.go api_op_CreateCustomDataIdentifier.go api_op_CreateFindingsFilter.go api_op_CreateInvitations.go api_op_CreateMember.go api_op_CreateSampleFindings.go api_op_DeclineInvitations.go api_op_DeleteCustomDataIdentifier.go api_op_DeleteFindingsFilter.go api_op_DeleteInvitations.go api_op_DeleteMember.go api_op_DescribeBuckets.go api_op_DescribeClassificationJob.go api_op_DescribeOrganizationConfiguration.go api_op_DisableMacie.go api_op_DisableOrganizationAdminAccount.go api_op_DisassociateFromAdministratorAccount.go api_op_DisassociateFromMasterAccount.go api_op_DisassociateMember.go api_op_EnableMacie.go api_op_EnableOrganizationAdminAccount.go api_op_GetAdministratorAccount.go api_op_GetBucketStatistics.go api_op_GetClassificationExportConfiguration.go api_op_GetCustomDataIdentifier.go api_op_GetFindingStatistics.go api_op_GetFindings.go api_op_GetFindingsFilter.go api_op_GetFindingsPublicationConfiguration.go api_op_GetInvitationsCount.go api_op_GetMacieSession.go api_op_GetMasterAccount.go api_op_GetMember.go api_op_GetUsageStatistics.go api_op_GetUsageTotals.go api_op_ListClassificationJobs.go api_op_ListCustomDataIdentifiers.go api_op_ListFindings.go api_op_ListFindingsFilters.go api_op_ListInvitations.go api_op_ListManagedDataIdentifiers.go api_op_ListMembers.go api_op_ListOrganizationAdminAccounts.go api_op_ListTagsForResource.go api_op_PutClassificationExportConfiguration.go api_op_PutFindingsPublicationConfiguration.go api_op_SearchResources.go api_op_TagResource.go api_op_TestCustomDataIdentifier.go api_op_UntagResource.go api_op_UpdateClassificationJob.go api_op_UpdateFindingsFilter.go api_op_UpdateMacieSession.go api_op_UpdateMemberSession.go api_op_UpdateOrganizationConfiguration.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v1.19.0
Published
Feb 24, 2022
Platform
js/wasm
Imports
34 packages
Last checked
3 weeks ago

Tools for package owners.