Documentation

Overview

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

    Amazon Macie Classic Amazon Macie Classic is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie Classic recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the Amazon Macie Classic User Guide (https://docs.aws.amazon.com/macie/latest/userguide/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

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

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

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type AssociateMemberAccountInput

          type AssociateMemberAccountInput struct {
          
          	// The ID of the AWS account that you want to associate with Amazon Macie Classic
          	// as a member account.
          	//
          	// This member is required.
          	MemberAccountId *string
          }

          type AssociateMemberAccountOutput

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

          type AssociateS3ResourcesInput

          type AssociateS3ResourcesInput struct {
          
          	// The S3 resources that you want to associate with Amazon Macie Classic for
          	// monitoring and data classification.
          	//
          	// This member is required.
          	S3Resources []types.S3ResourceClassification
          
          	// The ID of the Amazon Macie Classic member account whose resources you want to
          	// associate with Macie Classic.
          	MemberAccountId *string
          }

          type AssociateS3ResourcesOutput

          type AssociateS3ResourcesOutput struct {
          
          	// 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
          }

          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)

                  Associates a specified AWS 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)

                    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)

                      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)

                        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)

                          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)

                            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)

                              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 {
                              
                              	// The ID of the member account that you want to remove from Amazon Macie Classic.
                              	//
                              	// This member is required.
                              	MemberAccountId *string
                              }

                              type DisassociateMemberAccountOutput

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

                              type DisassociateS3ResourcesInput

                              type DisassociateS3ResourcesInput struct {
                              
                              	// 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
                              
                              	// The ID of the Amazon Macie Classic member account whose resources you want to
                              	// remove from being monitored by Macie Classic.
                              	MemberAccountId *string
                              }

                              type DisassociateS3ResourcesOutput

                              type DisassociateS3ResourcesOutput struct {
                              
                              	// 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
                              }

                              type EndpointResolver

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

                                EndpointResolver interface for resolving service endpoints.

                                func EndpointResolverFromURL

                                func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                  EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                  type EndpointResolverFunc

                                  type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                    EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                    func (EndpointResolverFunc) ResolveEndpoint

                                    func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                    type EndpointResolverOptions

                                    type EndpointResolverOptions = internalendpoints.Options

                                      EndpointResolverOptions is the service endpoint resolver options

                                      type 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

                                      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 {
                                        
                                        	// Use this parameter to indicate the maximum number of items that you want in the
                                        	// response. The default value is 250.
                                        	MaxResults *int32
                                        
                                        	// 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
                                        }

                                        type ListMemberAccountsOutput

                                        type ListMemberAccountsOutput struct {
                                        
                                        	// 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
                                        
                                        	// 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
                                        }

                                        type ListMemberAccountsPaginator

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

                                          ListMemberAccountsPaginator is a paginator for ListMemberAccounts

                                          func NewListMemberAccountsPaginator

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

                                            NewListMemberAccountsPaginator returns a new ListMemberAccountsPaginator

                                            func (*ListMemberAccountsPaginator) HasMorePages

                                            func (p *ListMemberAccountsPaginator) HasMorePages() bool

                                              HasMorePages returns a boolean indicating whether more pages are available

                                              func (*ListMemberAccountsPaginator) NextPage

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

                                                NextPage retrieves the next ListMemberAccounts page.

                                                type ListMemberAccountsPaginatorOptions

                                                type ListMemberAccountsPaginatorOptions struct {
                                                	// 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

                                                  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 {
                                                    
                                                    	// Use this parameter to indicate the maximum number of items that you want in the
                                                    	// response. The default value is 250.
                                                    	MaxResults *int32
                                                    
                                                    	// The Amazon Macie Classic member account ID whose associated S3 resources you
                                                    	// want to list.
                                                    	MemberAccountId *string
                                                    
                                                    	// 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
                                                    }

                                                    type ListS3ResourcesOutput

                                                    type ListS3ResourcesOutput struct {
                                                    
                                                    	// 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
                                                    
                                                    	// A list of the associated S3 resources returned by the action.
                                                    	S3Resources []types.S3ResourceClassification
                                                    
                                                    	// Metadata pertaining to the operation's result.
                                                    	ResultMetadata middleware.Metadata
                                                    }

                                                    type ListS3ResourcesPaginator

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

                                                      ListS3ResourcesPaginator is a paginator for ListS3Resources

                                                      func NewListS3ResourcesPaginator

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

                                                        NewListS3ResourcesPaginator returns a new ListS3ResourcesPaginator

                                                        func (*ListS3ResourcesPaginator) HasMorePages

                                                        func (p *ListS3ResourcesPaginator) HasMorePages() bool

                                                          HasMorePages returns a boolean indicating whether more pages are available

                                                          func (*ListS3ResourcesPaginator) NextPage

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

                                                            NextPage retrieves the next ListS3Resources page.

                                                            type ListS3ResourcesPaginatorOptions

                                                            type ListS3ResourcesPaginatorOptions struct {
                                                            	// 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
                                                              
                                                              	// Configures the events that will be sent to the configured logger.
                                                              	ClientLogMode aws.ClientLogMode
                                                              
                                                              	// The credentials object to use when signing requests.
                                                              	Credentials aws.CredentialsProvider
                                                              
                                                              	// The endpoint options to be used when attempting to resolve an endpoint.
                                                              	EndpointOptions EndpointResolverOptions
                                                              
                                                              	// The service endpoint resolver.
                                                              	EndpointResolver EndpointResolver
                                                              
                                                              	// Signature Version 4 (SigV4) Signer
                                                              	HTTPSignerV4 HTTPSignerV4
                                                              
                                                              	// The logger writer interface to write logging messages to.
                                                              	Logger logging.Logger
                                                              
                                                              	// The region to send requests to. (Required)
                                                              	Region string
                                                              
                                                              	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                              	// failures. When nil the API client will use a default retryer.
                                                              	Retryer aws.Retryer
                                                              
                                                              	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                              	// implementation if nil.
                                                              	HTTPClient HTTPClient
                                                              }

                                                              func (Options) Copy

                                                              func (o Options) Copy() Options

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

                                                                type ResolveEndpoint

                                                                type ResolveEndpoint struct {
                                                                	Resolver EndpointResolver
                                                                	Options  EndpointResolverOptions
                                                                }

                                                                func (*ResolveEndpoint) HandleSerialize

                                                                func (*ResolveEndpoint) ID

                                                                func (*ResolveEndpoint) ID() string

                                                                type UpdateS3ResourcesInput

                                                                type UpdateS3ResourcesInput struct {
                                                                
                                                                	// The S3 resources whose classification types you want to update.
                                                                	//
                                                                	// This member is required.
                                                                	S3ResourcesUpdate []types.S3ResourceClassificationUpdate
                                                                
                                                                	// The AWS ID of the Amazon Macie Classic member account whose S3 resources'
                                                                	// classification types you want to update.
                                                                	MemberAccountId *string
                                                                }

                                                                type UpdateS3ResourcesOutput

                                                                type UpdateS3ResourcesOutput struct {
                                                                
                                                                	// 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
                                                                }

                                                                Directories

                                                                Path Synopsis
                                                                internal