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"

Index

Constants

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

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AcceptInvitationInput

type AcceptInvitationInput struct {

	// The unique identifier for the invitation to accept.
	//
	// This member is required.
	InvitationId *string

	// The AWS account ID for the account that sent the invitation.
	//
	// This member is required.
	MasterAccount *string
}

type AcceptInvitationOutput

type AcceptInvitationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchGetCustomDataIdentifiersInput

type BatchGetCustomDataIdentifiersInput struct {

	// An array of strings that lists the unique identifiers for the custom data
	// identifiers to retrieve information about.
	Ids []*string
}

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 identifiers, one for each 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
}

type Client

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

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.

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 master 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 master 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 information about 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 information about the Amazon Macie configuration settings for an AWS organization.

func (*Client) DisableMacie

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

Disables an Amazon Macie account and deletes Macie resources for the account.

func (*Client) DisableOrganizationAdminAccount

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

Disables an account as a delegated administrator of Amazon Macie for an AWS organization.

func (*Client) DisassociateFromMasterAccount

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

Disassociates a member account from its Amazon Macie master account.

func (*Client) DisassociateMember

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

Disassociates an Amazon Macie master 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)

Enables an account as a delegated administrator of Amazon Macie for an AWS organization.

func (*Client) GetBucketStatistics

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

Retrieves (queries) aggregated statistical data for all the 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 information about 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 information about one or more findings.

func (*Client) GetFindingsFilter

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

Retrieves information about the criteria and other settings for a findings filter.

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 information about 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)

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

func (*Client) GetMember

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

Retrieves information about a member account that's associated with an Amazon Macie master 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 all the Amazon Macie membership invitations that were received by an account.

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 master account.

func (*Client) ListOrganizationAdminAccounts

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

Retrieves information about the account that's designated as the delegated administrator of Amazon Macie for an AWS organization.

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

Cancels 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 an Amazon Macie account, 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 master account to suspend or re-enable a member account.

func (*Client) UpdateOrganizationConfiguration

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

Updates Amazon Macie configuration settings for an AWS organization.

type CreateClassificationJobInput

type CreateClassificationJobInput struct {

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

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

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

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

	// Specifies whether to run the job immediately, after it's created.
	InitialRun *bool

	// 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 unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	//
	// This member is required.
	ClientToken *string

	// 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 of the jobType property to
	// ONE_TIME.
	ScheduleFrequency *types.JobScheduleFrequency

	// The custom data identifiers to use for data analysis and classification.
	CustomDataIdentifierIds []*string

	// The sampling depth, as a percentage, to apply when processing objects. This
	// value determines the percentage of eligible objects that the job analyzes. If
	// the value is less than 100, Amazon Macie randomly selects the objects to
	// analyze, up to the specified percentage.
	SamplingPercentage *int32
}

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
}

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 the identifier's name, depending on the actions that they're
	// allowed to perform in Amazon Macie.
	Name *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 the identifier's description, depending on the
	// actions that they're allowed to perform in Amazon Macie.
	Description *string

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

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

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

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

	// 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 4 - 90
	// characters.
	Keywords []*string

	// An array that lists specific character sequences (ignore words) to exclude from
	// the results. If the text matched by the regular expression is the same as 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 characters.
	IgnoreWords []*string
}

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
}

type CreateFindingsFilterInput

type CreateFindingsFilterInput struct {

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

	// 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
	// the filter's description, depending on the actions that they're allowed to
	// perform in Amazon Macie.
	Description *string

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

	// A unique, case-sensitive token that you provide to ensure the idempotency of the
	// request.
	ClientToken *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.
	//
	// This member is required.
	Action types.FindingsFilterAction

	// 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 the filter's name, depending on the actions that
	// they're allowed to perform in Amazon Macie.
	//
	// This member is required.
	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
}

type CreateFindingsFilterOutput

type CreateFindingsFilterOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateInvitationsInput

type CreateInvitationsInput struct {

	// A custom message to include in the invitation. Amazon Macie adds this message to
	// the standard content that it sends for an invitation.
	Message *string

	// Specifies whether to send an email notification to the root user of each account
	// that the invitation will be sent to. This notification is in addition to an
	// alert that the root user receives in AWS Personal Health Dashboard. To send an
	// email notification to the root user of each account, set this value to true.
	DisableEmailNotification *bool

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

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
}

type CreateMemberInput

type CreateMemberInput struct {

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

	// The details for the account to associate with the master account.
	//
	// This member is required.
	Account *types.AccountDetail
}

type CreateMemberOutput

type CreateMemberOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSampleFindingsInput

type CreateSampleFindingsInput struct {

	// An array that lists one or more types of findings to include in the set of
	// sample findings. Currently, the only supported value is
	// Policy:IAMUser/S3BucketEncryptionDisabled.
	FindingTypes []types.FindingType
}

type CreateSampleFindingsOutput

type CreateSampleFindingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeclineInvitationsInput

type DeclineInvitationsInput struct {

	// An array that lists AWS account IDs, one for each account that sent an
	// invitation to decline.
	//
	// This member is required.
	AccountIds []*string
}

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
}

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
}

type DeleteCustomDataIdentifierOutput

type DeleteCustomDataIdentifierOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

type DeleteFindingsFilterOutput

type DeleteFindingsFilterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteInvitationsInput

type DeleteInvitationsInput struct {

	// An array that lists AWS account IDs, one for each account that sent an
	// invitation to delete.
	//
	// This member is required.
	AccountIds []*string
}

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
}

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
}

type DeleteMemberOutput

type DeleteMemberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeBucketsInput

type DescribeBucketsInput struct {

	// The criteria to use to sort the query results.
	SortCriteria *types.BucketSortCriteria

	// 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 filter the query results.
	Criteria map[string]*types.BucketCriteriaAdditionalProperties
}

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
}

type DescribeClassificationJobInput

type DescribeClassificationJobInput struct {

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

type DescribeClassificationJobOutput

type DescribeClassificationJobOutput struct {

	// The schedule for running the job. Possible values are:
	//
	//     * ONE_TIME - The job
	// ran or will run 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

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

	// The custom data identifiers that the job uses to analyze data.
	CustomDataIdentifierIds []*string

	// The date and time, in UTC and extended ISO 8601 format, when the job last ran.
	LastRunTime *time.Time

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

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

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

	// The sampling depth, as a percentage, that the job applies when it processes
	// objects.
	SamplingPercentage *int32

	// Specifies whether the job has run for the first time.
	InitialRun *bool

	// The current status of the job. Possible values are:
	//
	//     * CANCELLED - The job
	// was cancelled by you or a user of the master account for your organization. A
	// job might also be cancelled if ownership of an S3 bucket changed while the job
	// was running, and that change affected the job's access to the bucket.
	//
	//     *
	// COMPLETE - Amazon Macie finished processing all the data specified for the
	// job.
	//
	//     * IDLE - For a recurring job, the previous scheduled run is complete
	// and the next scheduled run is pending. This value doesn't apply to jobs that
	// occur only once.
	//
	//     * PAUSED - Amazon Macie started the job, but completion of
	// the job would exceed one or more quotas for your account.
	//
	//     * RUNNING - The
	// job is in progress.
	JobStatus types.JobStatus

	// The S3 buckets that the job is configured to analyze, and the scope of that
	// analysis.
	S3JobDefinition *types.S3JobDefinition

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

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

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeOrganizationConfigurationInput

type DescribeOrganizationConfigurationInput struct {
}

type DescribeOrganizationConfigurationOutput

type DescribeOrganizationConfigurationOutput struct {

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

	// Specifies whether the maximum number of Amazon Macie member accounts are already
	// associated with the AWS organization.
	MaxAccountLimitReached *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisableMacieInput

type DisableMacieInput struct {
}

type DisableMacieOutput

type DisableMacieOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisableOrganizationAdminAccountInput

type DisableOrganizationAdminAccountInput struct {

	// The AWS account ID of the delegated administrator account.
	//
	// This member is required.
	AdminAccountId *string
}

type DisableOrganizationAdminAccountOutput

type DisableOrganizationAdminAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateFromMasterAccountInput

type DisassociateFromMasterAccountInput struct {
}

type DisassociateFromMasterAccountOutput

type DisassociateFromMasterAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type 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
}

type DisassociateMemberOutput

type DisassociateMemberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 AWS Security Hub and Amazon EventBridge (formerly
	// called Amazon CloudWatch Events).
	FindingPublishingFrequency types.FindingPublishingFrequency

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

type EnableMacieOutput

type EnableMacieOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EnableOrganizationAdminAccountInput

type EnableOrganizationAdminAccountInput struct {

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

	// The AWS account ID for the account.
	//
	// This member is required.
	AdminAccountId *string
}

type EnableOrganizationAdminAccountOutput

type EnableOrganizationAdminAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)

type GetBucketStatisticsInput

type GetBucketStatisticsInput struct {

	// The unique identifier for the AWS account.
	AccountId *string
}

type GetBucketStatisticsOutput

type GetBucketStatisticsOutput struct {

	// The total number of buckets, grouped by server-side encryption type. This object
	// also reports the total number of buckets that aren't encrypted.
	BucketCountByEncryptionType *types.BucketCountByEncryptionType

	// The total storage size, in bytes, of all the buckets.
	SizeInBytes *int64

	// The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last
	// analyzed the buckets.
	LastUpdated *time.Time

	// The total number of objects that Amazon Macie can analyze in all the buckets.
	// These objects use a file format, file extension, or content type that Amazon
	// Macie supports.
	ClassifiableObjectCount *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 objects in all the buckets.
	ObjectCount *int64

	// The total compressed storage size, in bytes, of all the buckets.
	SizeInBytesCompressed *int64

	// The total number of buckets that are shared with another AWS account.
	BucketCountBySharedAccessType *types.BucketCountBySharedAccessType

	// The total number of buckets.
	BucketCount *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetClassificationExportConfigurationInput

type GetClassificationExportConfigurationInput struct {
}

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
}

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
}

type GetCustomDataIdentifierOutput

type GetCustomDataIdentifierOutput struct {

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

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

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

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

	// 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 maximum number of characters that can exist between text that matches the
	// regex pattern and the character sequences specified by the keywords array. Macie
	// includes or excludes a result based on the proximity of a keyword to text that
	// matches the regex pattern.
	MaximumMatchDistance *int32

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

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

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetFindingStatisticsInput

type GetFindingStatisticsInput struct {

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

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

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
}

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
}

type GetFindingsFilterOutput

type GetFindingsFilterOutput struct {

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

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

	// 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 custom description of the filter.
	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

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

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

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

type GetFindingsInput

type GetFindingsInput struct {

	// The criteria for sorting the results of the request.
	SortCriteria *types.SortCriteria

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

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
}

type GetInvitationsCountInput

type GetInvitationsCountInput struct {
}

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
}

type GetMacieSessionInput

type GetMacieSessionInput struct {
}

type GetMacieSessionOutput

type GetMacieSessionOutput struct {

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

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

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetMasterAccountInput

type GetMasterAccountInput struct {
}

type GetMasterAccountOutput

type GetMasterAccountOutput struct {

	// The AWS account ID for the master account. If the accounts are associated by a
	// Macie membership invitation, this object also provides details about the
	// invitation that was sent and accepted to establish the relationship between the
	// accounts.
	Master *types.Invitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

type GetMemberOutput

type GetMemberOutput struct {

	// The AWS account ID for the account.
	AccountId *string

	// The Amazon Resource Name (ARN) of the account.
	Arn *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 a
	// Macie invitation hasn't been sent to the account.
	InvitedAt *time.Time

	// 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 master
	// account.
	UpdatedAt *time.Time

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

	// The current status of the relationship between the account and the master
	// 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 AWS account ID for the master account.
	MasterAccountId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetUsageStatisticsInput

type GetUsageStatisticsInput struct {

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

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

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

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

type GetUsageStatisticsOutput

type GetUsageStatisticsOutput struct {

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

type GetUsageTotalsInput

type GetUsageTotalsInput struct {
}

type GetUsageTotalsOutput

type GetUsageTotalsOutput struct {

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

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) error
}

type IdempotencyTokenProvider

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

IdempotencyTokenProvider interface for providing idempotency token

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 criteria to use to sort the results.
	SortCriteria *types.ListJobsSortCriteria

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

type ListClassificationJobsOutput

type ListClassificationJobsOutput 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, one for each job that meets the filter criteria specified
	// in the request.
	Items []*types.JobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

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
}

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
}

type ListFindingsFiltersOutput

type ListFindingsFiltersOutput 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, one for each filter that's associated with the account.
	FindingsFilterListItems []*types.FindingsFilterListItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListFindingsInput

type ListFindingsInput struct {

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

	// The criteria to use to sort the results.
	SortCriteria *types.SortCriteria

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

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

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
}

type ListInvitationsInput

type ListInvitationsInput struct {

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

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

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
}

type ListMembersInput

type ListMembersInput struct {

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

	// Specifies which accounts to include in the response, based on the status of an
	// account's relationship with the master account. By default, the response
	// includes only current member accounts. To include all accounts, set the value
	// for this parameter to false.
	OnlyAssociated *string

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

type ListMembersOutput

type ListMembersOutput struct {

	// An array of objects, one for each account that's associated with the master
	// account and meets the criteria specified by the onlyAssociated request
	// parameter.
	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
}

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
}

type ListOrganizationAdminAccountsOutput

type ListOrganizationAdminAccountsOutput struct {

	// An array of objects, one for each account that's designated as a delegated
	// administrator of Amazon Macie for the AWS organization. Of those accounts, only
	// one 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
}

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
}

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
}

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

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// 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 region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetIdempotencyTokenProvider

func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

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
}

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
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type TagResourceInput

type TagResourceInput struct {

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

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

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

	// An array that lists specific character sequences (ignore words) to exclude from
	// the results. If the text matched by the regular expression is the same as 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 characters.
	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 4 - 90
	// characters.
	Keywords []*string

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

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

type TestCustomDataIdentifierOutput

type TestCustomDataIdentifierOutput struct {

	// The number of instances of sample text that matched the detection criteria
	// specified in the custom data identifier.
	MatchCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateClassificationJobInput

type UpdateClassificationJobInput struct {

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

	// The status to change the job's status to. The only supported value is CANCELLED,
	// which cancels the job completely.
	//
	// This member is required.
	JobStatus types.JobStatus
}

type UpdateClassificationJobOutput

type UpdateClassificationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateFindingsFilterInput

type UpdateFindingsFilterInput struct {

	// 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 the filter's
	// 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 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 the filter's name, depending on the actions that they're allowed to
	// perform in Amazon Macie.
	Name *string

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

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

type UpdateFindingsFilterOutput

type UpdateFindingsFilterOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateMacieSessionInput

type UpdateMacieSessionInput struct {

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

	// Specifies whether to change the status of 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
}

type UpdateMacieSessionOutput

type UpdateMacieSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateMemberSessionInput

type UpdateMemberSessionInput struct {

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

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

type UpdateMemberSessionOutput

type UpdateMemberSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateOrganizationConfigurationInput

type UpdateOrganizationConfigurationInput struct {

	// Specifies whether Amazon Macie is enabled automatically for each account, when
	// the account is added to the AWS organization.
	//
	// This member is required.
	AutoEnable *bool
}

type UpdateOrganizationConfigurationOutput

type UpdateOrganizationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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_DisassociateFromMasterAccount.go api_op_DisassociateMember.go api_op_EnableMacie.go api_op_EnableOrganizationAdminAccount.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_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_ListMembers.go api_op_ListOrganizationAdminAccounts.go api_op_ListTagsForResource.go api_op_PutClassificationExportConfiguration.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 endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.26.0
Published
Oct 1, 2020
Platform
darwin/amd64
Imports
28 packages
Last checked
3 weeks ago

Tools for package owners.