macie

package module
v1.19.2 Latest Latest
Warning

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

 Go to latest Published: Nov 15, 2023 License: Apache-2.0 Imports: 39 Imported by: 5

Documentation

Overview

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

Amazon Macie Classic Amazon Macie Classic has been discontinued and is no longer available. A new Amazon Macie is now available with significant design improvements and additional features, at a lower price and in most Amazon Web Services Regions. We encourage you to take advantage of the new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Macie, see Amazon Macie (http://aws.amazon.com/macie/) . To learn how to use the new Macie, see the Amazon Macie User Guide (https://docs.aws.amazon.com/macie/latest/user/what-is-macie.html) .

Index

Constants

View Source 
const ServiceAPIVersion = "2017-12-19"
View Source 
const ServiceID = "Macie"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.16.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.19.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.19.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateMemberAccountInput 

type AssociateMemberAccountInput struct {

	// (Discontinued) The ID of the Amazon Web Services account that you want to
	// associate with Amazon Macie Classic as a member account.
	//
	// This member is required.
	MemberAccountId *string
	// contains filtered or unexported fields
}

type AssociateMemberAccountOutput 

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

type AssociateS3ResourcesInput 

type AssociateS3ResourcesInput struct {

	// (Discontinued) The S3 resources that you want to associate with Amazon Macie
	// Classic for monitoring and data classification.
	//
	// This member is required.
	S3Resources []types.S3ResourceClassification

	// (Discontinued) The ID of the Amazon Macie Classic member account whose
	// resources you want to associate with Macie Classic.
	MemberAccountId *string
	// contains filtered or unexported fields
}

type AssociateS3ResourcesOutput 

type AssociateS3ResourcesOutput struct {

	// (Discontinued) S3 resources that couldn't be associated with Amazon Macie
	// Classic. An error code and an error message are provided for each failed item.
	FailedS3Resources []types.FailedS3Resource

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

type AuthResolverParameters added in v1.19.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.19.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

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

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

func (c *Client) AssociateMemberAccount(ctx context.Context, params *AssociateMemberAccountInput, optFns ...func(*Options)) (*AssociateMemberAccountOutput, error)

(Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member account.

func (*Client) AssociateS3Resources 

func (c *Client) AssociateS3Resources(ctx context.Context, params *AssociateS3ResourcesInput, optFns ...func(*Options)) (*AssociateS3ResourcesOutput, error)

(Discontinued) Associates specified S3 resources with Amazon Macie Classic for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action associates specified S3 resources with Macie Classic for the specified member account.

func (*Client) DisassociateMemberAccount 

func (c *Client) DisassociateMemberAccount(ctx context.Context, params *DisassociateMemberAccountInput, optFns ...func(*Options)) (*DisassociateMemberAccountOutput, error)

(Discontinued) Removes the specified member account from Amazon Macie Classic.

func (*Client) DisassociateS3Resources 

func (c *Client) DisassociateS3Resources(ctx context.Context, params *DisassociateS3ResourcesInput, optFns ...func(*Options)) (*DisassociateS3ResourcesOutput, error)

(Discontinued) Removes specified S3 resources from being monitored by Amazon Macie Classic. If memberAccountId isn't specified, the action removes specified S3 resources from Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action removes specified S3 resources from Macie Classic for the specified member account.

func (*Client) ListMemberAccounts 

func (c *Client) ListMemberAccounts(ctx context.Context, params *ListMemberAccountsInput, optFns ...func(*Options)) (*ListMemberAccountsOutput, error)

(Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.

func (*Client) ListS3Resources 

func (c *Client) ListS3Resources(ctx context.Context, params *ListS3ResourcesInput, optFns ...func(*Options)) (*ListS3ResourcesOutput, error)

(Discontinued) Lists all the S3 resources associated with Amazon Macie Classic. If memberAccountId isn't specified, the action lists the S3 resources associated with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action lists the S3 resources associated with Macie Classic for the specified member account.

func (*Client) UpdateS3Resources 

func (c *Client) UpdateS3Resources(ctx context.Context, params *UpdateS3ResourcesInput, optFns ...func(*Options)) (*UpdateS3ResourcesOutput, error)

(Discontinued) Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Macie Classic for the specified member account.

type DisassociateMemberAccountInput 

type DisassociateMemberAccountInput struct {

	// (Discontinued) The ID of the member account that you want to remove from Amazon
	// Macie Classic.
	//
	// This member is required.
	MemberAccountId *string
	// contains filtered or unexported fields
}

type DisassociateMemberAccountOutput 

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

type DisassociateS3ResourcesInput 

type DisassociateS3ResourcesInput struct {

	// (Discontinued) The S3 resources (buckets or prefixes) that you want to remove
	// from being monitored and classified by Amazon Macie Classic.
	//
	// This member is required.
	AssociatedS3Resources []types.S3Resource

	// (Discontinued) The ID of the Amazon Macie Classic member account whose
	// resources you want to remove from being monitored by Macie Classic.
	MemberAccountId *string
	// contains filtered or unexported fields
}

type DisassociateS3ResourcesOutput 

type DisassociateS3ResourcesOutput struct {

	// (Discontinued) S3 resources that couldn't be removed from being monitored and
	// classified by Amazon Macie Classic. An error code and an error message are
	// provided for each failed item.
	FailedS3Resources []types.FailedS3Resource

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

type EndpointParameters added in v1.16.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.16.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.16.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

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 added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.16.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.16.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

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 ListMemberAccountsAPIClient added in v0.30.0 

type ListMemberAccountsAPIClient interface {
	ListMemberAccounts(context.Context, *ListMemberAccountsInput, ...func(*Options)) (*ListMemberAccountsOutput, error)
}

ListMemberAccountsAPIClient is a client that implements the ListMemberAccounts operation.

type ListMemberAccountsInput 

type ListMemberAccountsInput struct {

	// (Discontinued) Use this parameter to indicate the maximum number of items that
	// you want in the response. The default value is 250.
	MaxResults *int32

	// (Discontinued) Use this parameter when paginating results. Set the value of
	// this parameter to null on your first call to the ListMemberAccounts action.
	// Subsequent calls to the action fill nextToken in the request with the value of
	// nextToken from the previous response to continue listing data.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMemberAccountsOutput 

type ListMemberAccountsOutput struct {

	// (Discontinued) A list of the Amazon Macie Classic member accounts returned by
	// the action. The current Macie Classic administrator account is also included in
	// this list.
	MemberAccounts []types.MemberAccount

	// (Discontinued) When a response is generated, if there is more data to be
	// listed, this parameter is present in the response and contains the value to use
	// for the nextToken parameter in a subsequent pagination request. If there is no
	// more data to be listed, this parameter is set to null.
	NextToken *string

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

type ListMemberAccountsPaginator added in v0.30.0 

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

ListMemberAccountsPaginator is a paginator for ListMemberAccounts

func NewListMemberAccountsPaginator added in v0.30.0 

func NewListMemberAccountsPaginator(client ListMemberAccountsAPIClient, params *ListMemberAccountsInput, optFns ...func(*ListMemberAccountsPaginatorOptions)) *ListMemberAccountsPaginator

NewListMemberAccountsPaginator returns a new ListMemberAccountsPaginator

func (*ListMemberAccountsPaginator) HasMorePages added in v0.30.0 

func (p *ListMemberAccountsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMemberAccountsPaginator) NextPage added in v0.30.0 

func (p *ListMemberAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMemberAccountsOutput, error)

NextPage retrieves the next ListMemberAccounts page.

type ListMemberAccountsPaginatorOptions added in v0.30.0 

type ListMemberAccountsPaginatorOptions struct {
	// (Discontinued) Use this parameter to indicate the maximum number of items that
	// you want in the response. The default value is 250.
	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
}

ListMemberAccountsPaginatorOptions is the paginator options for ListMemberAccounts

type ListS3ResourcesAPIClient added in v0.30.0 

type ListS3ResourcesAPIClient interface {
	ListS3Resources(context.Context, *ListS3ResourcesInput, ...func(*Options)) (*ListS3ResourcesOutput, error)
}

ListS3ResourcesAPIClient is a client that implements the ListS3Resources operation.

type ListS3ResourcesInput 

type ListS3ResourcesInput struct {

	// (Discontinued) Use this parameter to indicate the maximum number of items that
	// you want in the response. The default value is 250.
	MaxResults *int32

	// (Discontinued) The Amazon Macie Classic member account ID whose associated S3
	// resources you want to list.
	MemberAccountId *string

	// (Discontinued) Use this parameter when paginating results. Set its value to
	// null on your first call to the ListS3Resources action. Subsequent calls to the
	// action fill nextToken in the request with the value of nextToken from the
	// previous response to continue listing data.
	NextToken *string
	// contains filtered or unexported fields
}

type ListS3ResourcesOutput 

type ListS3ResourcesOutput struct {

	// (Discontinued) When a response is generated, if there is more data to be
	// listed, this parameter is present in the response and contains the value to use
	// for the nextToken parameter in a subsequent pagination request. If there is no
	// more data to be listed, this parameter is set to null.
	NextToken *string

	// (Discontinued) A list of the associated S3 resources returned by the action.
	S3Resources []types.S3ResourceClassification

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

type ListS3ResourcesPaginator added in v0.30.0 

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

ListS3ResourcesPaginator is a paginator for ListS3Resources

func NewListS3ResourcesPaginator added in v0.30.0 

func NewListS3ResourcesPaginator(client ListS3ResourcesAPIClient, params *ListS3ResourcesInput, optFns ...func(*ListS3ResourcesPaginatorOptions)) *ListS3ResourcesPaginator

NewListS3ResourcesPaginator returns a new ListS3ResourcesPaginator

func (*ListS3ResourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListS3ResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListS3ResourcesPaginator) NextPage added in v0.30.0 

func (p *ListS3ResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListS3ResourcesOutput, error)

NextPage retrieves the next ListS3Resources page.

type ListS3ResourcesPaginatorOptions added in v0.30.0 

type ListS3ResourcesPaginatorOptions struct {
	// (Discontinued) Use this parameter to indicate the maximum number of items that
	// you want in the response. The default value is 250.
	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
}

ListS3ResourcesPaginatorOptions is the paginator options for ListS3Resources

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.19.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type UpdateS3ResourcesInput 

type UpdateS3ResourcesInput struct {

	// (Discontinued) The S3 resources whose classification types you want to update.
	//
	// This member is required.
	S3ResourcesUpdate []types.S3ResourceClassificationUpdate

	// (Discontinued) The Amazon Web Services account ID of the Amazon Macie Classic
	// member account whose S3 resources' classification types you want to update.
	MemberAccountId *string
	// contains filtered or unexported fields
}

type UpdateS3ResourcesOutput 

type UpdateS3ResourcesOutput struct {

	// (Discontinued) The S3 resources whose classification types can't be updated. An
	// error code and an error message are provided for each failed item.
	FailedS3Resources []types.FailedS3Resource

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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