macie

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 5

Documentation

Overview

Package macie provides the client and types for making API requests to Amazon Macie.

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

A new Amazon Macie is now available with significant design improvements and additional features, at a lower price and in most AWS Regions. We encourage you to explore and use the new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Amazon Macie, see Amazon Macie (https://aws.amazon.com/macie/).

See https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19 for more information on this service.

See macie package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/macie/

Using the Client

To use Amazon Macie with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Macie client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/macie/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon Macie" // Service's name
	ServiceID   = "Macie"        // Service's identifier
	EndpointsID = "macie"        // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have required permissions to access the requested resource.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// Internal server error.
	ErrCodeInternalException = "InternalException"

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// The request was rejected because an invalid or out-of-range value was supplied
	// for an input parameter.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request was rejected because it attempted to create resources beyond
	// the current AWS account limits. The error code describes the limit exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"
)

Variables

This section is empty.

Functions

This section is empty.

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.
	//
	// MemberAccountId is a required field
	MemberAccountId *string `locationName:"memberAccountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateMemberAccountInput) String 

func (s AssociateMemberAccountInput) String() string

String returns the string representation

func (*AssociateMemberAccountInput) Validate 

func (s *AssociateMemberAccountInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateMemberAccountOutput 

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

func (AssociateMemberAccountOutput) String 

func (s AssociateMemberAccountOutput) String() string

String returns the string representation

type AssociateMemberAccountRequest 

type AssociateMemberAccountRequest struct {
	*aws.Request
	Input *AssociateMemberAccountInput
	Copy  func(*AssociateMemberAccountInput) AssociateMemberAccountRequest
}

AssociateMemberAccountRequest is the request type for the AssociateMemberAccount API operation.

func (AssociateMemberAccountRequest) Send 

func (r AssociateMemberAccountRequest) Send(ctx context.Context) (*AssociateMemberAccountResponse, error)

Send marshals and sends the AssociateMemberAccount API request.

type AssociateMemberAccountResponse added in v0.9.0 

type AssociateMemberAccountResponse struct {
	*AssociateMemberAccountOutput
	// contains filtered or unexported fields
}

AssociateMemberAccountResponse is the response type for the AssociateMemberAccount API operation.

func (*AssociateMemberAccountResponse) SDKResponseMetdata added in v0.9.0 

func (r *AssociateMemberAccountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateMemberAccount request.

type AssociateS3ResourcesInput 

type AssociateS3ResourcesInput struct {

	// The ID of the Amazon Macie Classic member account whose resources you want
	// to associate with Macie Classic.
	MemberAccountId *string `locationName:"memberAccountId" type:"string"`

	// The S3 resources that you want to associate with Amazon Macie Classic for
	// monitoring and data classification.
	//
	// S3Resources is a required field
	S3Resources []S3ResourceClassification `locationName:"s3Resources" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateS3ResourcesInput) String 

func (s AssociateS3ResourcesInput) String() string

String returns the string representation

func (*AssociateS3ResourcesInput) Validate 

func (s *AssociateS3ResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 []FailedS3Resource `locationName:"failedS3Resources" type:"list"`
	// contains filtered or unexported fields
}

func (AssociateS3ResourcesOutput) String 

func (s AssociateS3ResourcesOutput) String() string

String returns the string representation

type AssociateS3ResourcesRequest 

type AssociateS3ResourcesRequest struct {
	*aws.Request
	Input *AssociateS3ResourcesInput
	Copy  func(*AssociateS3ResourcesInput) AssociateS3ResourcesRequest
}

AssociateS3ResourcesRequest is the request type for the AssociateS3Resources API operation.

func (AssociateS3ResourcesRequest) Send 

func (r AssociateS3ResourcesRequest) Send(ctx context.Context) (*AssociateS3ResourcesResponse, error)

Send marshals and sends the AssociateS3Resources API request.

type AssociateS3ResourcesResponse added in v0.9.0 

type AssociateS3ResourcesResponse struct {
	*AssociateS3ResourcesOutput
	// contains filtered or unexported fields
}

AssociateS3ResourcesResponse is the response type for the AssociateS3Resources API operation.

func (*AssociateS3ResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *AssociateS3ResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateS3Resources request.

type ClassificationType 

type ClassificationType struct {

	// A continuous classification of the objects that are added to a specified
	// S3 bucket. Amazon Macie Classic begins performing continuous classification
	// after a bucket is successfully associated with Amazon Macie Classic.
	//
	// Continuous is a required field
	Continuous S3ContinuousClassificationType `locationName:"continuous" type:"string" required:"true" enum:"true"`

	// A one-time classification of all of the existing objects in a specified S3
	// bucket.
	//
	// OneTime is a required field
	OneTime S3OneTimeClassificationType `locationName:"oneTime" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The classification type that Amazon Macie Classic applies to the associated S3 resources.

func (ClassificationType) String 

func (s ClassificationType) String() string

String returns the string representation

func (*ClassificationType) Validate 

func (s *ClassificationType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ClassificationTypeUpdate 

type ClassificationTypeUpdate struct {

	// A continuous classification of the objects that are added to a specified
	// S3 bucket. Amazon Macie Classic begins performing continuous classification
	// after a bucket is successfully associated with Amazon Macie Classic.
	Continuous S3ContinuousClassificationType `locationName:"continuous" type:"string" enum:"true"`

	// A one-time classification of all of the existing objects in a specified S3
	// bucket.
	OneTime S3OneTimeClassificationType `locationName:"oneTime" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The classification type that Amazon Macie Classic applies to the associated S3 resources. At least one of the classification types (oneTime or continuous) must be specified.

func (ClassificationTypeUpdate) String 

func (s ClassificationTypeUpdate) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon Macie. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := macie.New(myConfig)

func (*Client) AssociateMemberAccountRequest added in v0.9.0 

func (c *Client) AssociateMemberAccountRequest(input *AssociateMemberAccountInput) AssociateMemberAccountRequest

AssociateMemberAccountRequest returns a request value for making API operation for Amazon Macie.

Associates a specified AWS account with Amazon Macie Classic as a member account. 

// Example sending a request using AssociateMemberAccountRequest.
req := client.AssociateMemberAccountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/AssociateMemberAccount

func (*Client) AssociateS3ResourcesRequest added in v0.9.0 

func (c *Client) AssociateS3ResourcesRequest(input *AssociateS3ResourcesInput) AssociateS3ResourcesRequest

AssociateS3ResourcesRequest returns a request value for making API operation for Amazon Macie.

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 master account. If memberAccountId is specified, the action associates specified S3 resources with Macie Classic for the specified member account. 

// Example sending a request using AssociateS3ResourcesRequest.
req := client.AssociateS3ResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/AssociateS3Resources

func (*Client) DisassociateMemberAccountRequest added in v0.9.0 

func (c *Client) DisassociateMemberAccountRequest(input *DisassociateMemberAccountInput) DisassociateMemberAccountRequest

DisassociateMemberAccountRequest returns a request value for making API operation for Amazon Macie.

Removes the specified member account from Amazon Macie Classic. 

// Example sending a request using DisassociateMemberAccountRequest.
req := client.DisassociateMemberAccountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/DisassociateMemberAccount

func (*Client) DisassociateS3ResourcesRequest added in v0.9.0 

func (c *Client) DisassociateS3ResourcesRequest(input *DisassociateS3ResourcesInput) DisassociateS3ResourcesRequest

DisassociateS3ResourcesRequest returns a request value for making API operation for Amazon Macie.

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 master account. If memberAccountId is specified, the action removes specified S3 resources from Macie Classic for the specified member account. 

// Example sending a request using DisassociateS3ResourcesRequest.
req := client.DisassociateS3ResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/DisassociateS3Resources

func (*Client) ListMemberAccountsRequest added in v0.9.0 

func (c *Client) ListMemberAccountsRequest(input *ListMemberAccountsInput) ListMemberAccountsRequest

ListMemberAccountsRequest returns a request value for making API operation for Amazon Macie.

Lists all Amazon Macie Classic member accounts for the current Amazon Macie Classic master account. 

// Example sending a request using ListMemberAccountsRequest.
req := client.ListMemberAccountsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/ListMemberAccounts

func (*Client) ListS3ResourcesRequest added in v0.9.0 

func (c *Client) ListS3ResourcesRequest(input *ListS3ResourcesInput) ListS3ResourcesRequest

ListS3ResourcesRequest returns a request value for making API operation for Amazon Macie.

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

// Example sending a request using ListS3ResourcesRequest.
req := client.ListS3ResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/ListS3Resources

func (*Client) UpdateS3ResourcesRequest added in v0.9.0 

func (c *Client) UpdateS3ResourcesRequest(input *UpdateS3ResourcesInput) UpdateS3ResourcesRequest

UpdateS3ResourcesRequest returns a request value for making API operation for Amazon Macie.

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 master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the specified member account. 

// Example sending a request using UpdateS3ResourcesRequest.
req := client.UpdateS3ResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/macie-2017-12-19/UpdateS3Resources

type DisassociateMemberAccountInput 

type DisassociateMemberAccountInput struct {

	// The ID of the member account that you want to remove from Amazon Macie Classic.
	//
	// MemberAccountId is a required field
	MemberAccountId *string `locationName:"memberAccountId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateMemberAccountInput) String 

func (s DisassociateMemberAccountInput) String() string

String returns the string representation

func (*DisassociateMemberAccountInput) Validate 

func (s *DisassociateMemberAccountInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateMemberAccountOutput 

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

func (DisassociateMemberAccountOutput) String 

func (s DisassociateMemberAccountOutput) String() string

String returns the string representation

type DisassociateMemberAccountRequest 

type DisassociateMemberAccountRequest struct {
	*aws.Request
	Input *DisassociateMemberAccountInput
	Copy  func(*DisassociateMemberAccountInput) DisassociateMemberAccountRequest
}

DisassociateMemberAccountRequest is the request type for the DisassociateMemberAccount API operation.

func (DisassociateMemberAccountRequest) Send 

func (r DisassociateMemberAccountRequest) Send(ctx context.Context) (*DisassociateMemberAccountResponse, error)

Send marshals and sends the DisassociateMemberAccount API request.

type DisassociateMemberAccountResponse added in v0.9.0 

type DisassociateMemberAccountResponse struct {
	*DisassociateMemberAccountOutput
	// contains filtered or unexported fields
}

DisassociateMemberAccountResponse is the response type for the DisassociateMemberAccount API operation.

func (*DisassociateMemberAccountResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisassociateMemberAccountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateMemberAccount request.

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.
	//
	// AssociatedS3Resources is a required field
	AssociatedS3Resources []S3Resource `locationName:"associatedS3Resources" type:"list" required:"true"`

	// The ID of the Amazon Macie Classic member account whose resources you want
	// to remove from being monitored by Amazon Macie Classic.
	MemberAccountId *string `locationName:"memberAccountId" type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateS3ResourcesInput) String 

func (s DisassociateS3ResourcesInput) String() string

String returns the string representation

func (*DisassociateS3ResourcesInput) Validate 

func (s *DisassociateS3ResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 []FailedS3Resource `locationName:"failedS3Resources" type:"list"`
	// contains filtered or unexported fields
}

func (DisassociateS3ResourcesOutput) String 

func (s DisassociateS3ResourcesOutput) String() string

String returns the string representation

type DisassociateS3ResourcesRequest 

type DisassociateS3ResourcesRequest struct {
	*aws.Request
	Input *DisassociateS3ResourcesInput
	Copy  func(*DisassociateS3ResourcesInput) DisassociateS3ResourcesRequest
}

DisassociateS3ResourcesRequest is the request type for the DisassociateS3Resources API operation.

func (DisassociateS3ResourcesRequest) Send 

func (r DisassociateS3ResourcesRequest) Send(ctx context.Context) (*DisassociateS3ResourcesResponse, error)

Send marshals and sends the DisassociateS3Resources API request.

type DisassociateS3ResourcesResponse added in v0.9.0 

type DisassociateS3ResourcesResponse struct {
	*DisassociateS3ResourcesOutput
	// contains filtered or unexported fields
}

DisassociateS3ResourcesResponse is the response type for the DisassociateS3Resources API operation.

func (*DisassociateS3ResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisassociateS3ResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateS3Resources request.

type FailedS3Resource 

type FailedS3Resource struct {

	// The status code of a failed item.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// The error message of a failed item.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The failed S3 resources.
	FailedItem *S3Resource `locationName:"failedItem" type:"structure"`
	// contains filtered or unexported fields
}

Includes details about the failed S3 resources.

func (FailedS3Resource) String 

func (s FailedS3Resource) String() string

String returns the string representation

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 *int64 `locationName:"maxResults" type:"integer"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListMemberAccountsInput) String 

func (s ListMemberAccountsInput) String() string

String returns the string representation

type ListMemberAccountsOutput 

type ListMemberAccountsOutput struct {

	// A list of the Amazon Macie Classic member accounts returned by the action.
	// The current master account is also included in this list.
	MemberAccounts []MemberAccount `locationName:"memberAccounts" type:"list"`

	// 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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListMemberAccountsOutput) String 

func (s ListMemberAccountsOutput) String() string

String returns the string representation

type ListMemberAccountsPaginator added in v0.9.0 

type ListMemberAccountsPaginator struct {
	aws.Pager
}

ListMemberAccountsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListMemberAccountsPaginator added in v0.9.0 

func NewListMemberAccountsPaginator(req ListMemberAccountsRequest) ListMemberAccountsPaginator

NewListMemberAccountsRequestPaginator returns a paginator for ListMemberAccounts. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListMemberAccountsRequest(input)
p := macie.NewListMemberAccountsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListMemberAccountsPaginator) CurrentPage added in v0.9.0 

func (p *ListMemberAccountsPaginator) CurrentPage() *ListMemberAccountsOutput

type ListMemberAccountsRequest 

type ListMemberAccountsRequest struct {
	*aws.Request
	Input *ListMemberAccountsInput
	Copy  func(*ListMemberAccountsInput) ListMemberAccountsRequest
}

ListMemberAccountsRequest is the request type for the ListMemberAccounts API operation.

func (ListMemberAccountsRequest) Send 

func (r ListMemberAccountsRequest) Send(ctx context.Context) (*ListMemberAccountsResponse, error)

Send marshals and sends the ListMemberAccounts API request.

type ListMemberAccountsResponse added in v0.9.0 

type ListMemberAccountsResponse struct {
	*ListMemberAccountsOutput
	// contains filtered or unexported fields
}

ListMemberAccountsResponse is the response type for the ListMemberAccounts API operation.

func (*ListMemberAccountsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListMemberAccountsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListMemberAccounts request.

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 *int64 `locationName:"maxResults" type:"integer"`

	// The Amazon Macie Classic member account ID whose associated S3 resources
	// you want to list.
	MemberAccountId *string `locationName:"memberAccountId" type:"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 `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListS3ResourcesInput) String 

func (s ListS3ResourcesInput) String() string

String returns the string representation

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 `locationName:"nextToken" type:"string"`

	// A list of the associated S3 resources returned by the action.
	S3Resources []S3ResourceClassification `locationName:"s3Resources" type:"list"`
	// contains filtered or unexported fields
}

func (ListS3ResourcesOutput) String 

func (s ListS3ResourcesOutput) String() string

String returns the string representation

type ListS3ResourcesPaginator added in v0.9.0 

type ListS3ResourcesPaginator struct {
	aws.Pager
}

ListS3ResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListS3ResourcesPaginator added in v0.9.0 

func NewListS3ResourcesPaginator(req ListS3ResourcesRequest) ListS3ResourcesPaginator

NewListS3ResourcesRequestPaginator returns a paginator for ListS3Resources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListS3ResourcesRequest(input)
p := macie.NewListS3ResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListS3ResourcesPaginator) CurrentPage added in v0.9.0 

func (p *ListS3ResourcesPaginator) CurrentPage() *ListS3ResourcesOutput

type ListS3ResourcesRequest 

type ListS3ResourcesRequest struct {
	*aws.Request
	Input *ListS3ResourcesInput
	Copy  func(*ListS3ResourcesInput) ListS3ResourcesRequest
}

ListS3ResourcesRequest is the request type for the ListS3Resources API operation.

func (ListS3ResourcesRequest) Send 

func (r ListS3ResourcesRequest) Send(ctx context.Context) (*ListS3ResourcesResponse, error)

Send marshals and sends the ListS3Resources API request.

type ListS3ResourcesResponse added in v0.9.0 

type ListS3ResourcesResponse struct {
	*ListS3ResourcesOutput
	// contains filtered or unexported fields
}

ListS3ResourcesResponse is the response type for the ListS3Resources API operation.

func (*ListS3ResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListS3ResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListS3Resources request.

type MemberAccount 

type MemberAccount struct {

	// The AWS account ID of the Amazon Macie Classic member account.
	AccountId *string `locationName:"accountId" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the Amazon Macie Classic member account.

func (MemberAccount) String 

func (s MemberAccount) String() string

String returns the string representation

type S3ContinuousClassificationType 

type S3ContinuousClassificationType string
const (
	S3ContinuousClassificationTypeFull S3ContinuousClassificationType = "FULL"
)

Enum values for S3ContinuousClassificationType

func (S3ContinuousClassificationType) MarshalValue 

func (enum S3ContinuousClassificationType) MarshalValue() (string, error)

func (S3ContinuousClassificationType) MarshalValueBuf 

func (enum S3ContinuousClassificationType) MarshalValueBuf(b []byte) ([]byte, error)

type S3OneTimeClassificationType 

type S3OneTimeClassificationType string
const (
	S3OneTimeClassificationTypeFull S3OneTimeClassificationType = "FULL"
	S3OneTimeClassificationTypeNone S3OneTimeClassificationType = "NONE"
)

Enum values for S3OneTimeClassificationType

func (S3OneTimeClassificationType) MarshalValue 

func (enum S3OneTimeClassificationType) MarshalValue() (string, error)

func (S3OneTimeClassificationType) MarshalValueBuf 

func (enum S3OneTimeClassificationType) MarshalValueBuf(b []byte) ([]byte, error)

type S3Resource 

type S3Resource struct {

	// The name of the S3 bucket.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" type:"string" required:"true"`

	// The prefix of the S3 bucket.
	Prefix *string `locationName:"prefix" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the S3 resource. This data type is used as a request parameter in the DisassociateS3Resources action and can be used as a response parameter in the AssociateS3Resources and UpdateS3Resources actions.

func (S3Resource) String 

func (s S3Resource) String() string

String returns the string representation

func (*S3Resource) Validate 

func (s *S3Resource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3ResourceClassification 

type S3ResourceClassification struct {

	// The name of the S3 bucket that you want to associate with Amazon Macie Classic.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" type:"string" required:"true"`

	// The classification type that you want to specify for the resource associated
	// with Amazon Macie Classic.
	//
	// ClassificationType is a required field
	ClassificationType *ClassificationType `locationName:"classificationType" type:"structure" required:"true"`

	// The prefix of the S3 bucket that you want to associate with Amazon Macie
	// Classic.
	Prefix *string `locationName:"prefix" type:"string"`
	// contains filtered or unexported fields
}

The S3 resources that you want to associate with Amazon Macie Classic for monitoring and data classification. This data type is used as a request parameter in the AssociateS3Resources action and a response parameter in the ListS3Resources action.

func (S3ResourceClassification) String 

func (s S3ResourceClassification) String() string

String returns the string representation

func (*S3ResourceClassification) Validate 

func (s *S3ResourceClassification) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3ResourceClassificationUpdate 

type S3ResourceClassificationUpdate struct {

	// The name of the S3 bucket whose classification types you want to update.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" type:"string" required:"true"`

	// The classification type that you want to update for the resource associated
	// with Amazon Macie Classic.
	//
	// ClassificationTypeUpdate is a required field
	ClassificationTypeUpdate *ClassificationTypeUpdate `locationName:"classificationTypeUpdate" type:"structure" required:"true"`

	// The prefix of the S3 bucket whose classification types you want to update.
	Prefix *string `locationName:"prefix" type:"string"`
	// contains filtered or unexported fields
}

The S3 resources whose classification types you want to update. This data type is used as a request parameter in the UpdateS3Resources action.

func (S3ResourceClassificationUpdate) String 

func (s S3ResourceClassificationUpdate) String() string

String returns the string representation

func (*S3ResourceClassificationUpdate) Validate 

func (s *S3ResourceClassificationUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateS3ResourcesInput 

type UpdateS3ResourcesInput struct {

	// The AWS ID of the Amazon Macie Classic member account whose S3 resources'
	// classification types you want to update.
	MemberAccountId *string `locationName:"memberAccountId" type:"string"`

	// The S3 resources whose classification types you want to update.
	//
	// S3ResourcesUpdate is a required field
	S3ResourcesUpdate []S3ResourceClassificationUpdate `locationName:"s3ResourcesUpdate" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateS3ResourcesInput) String 

func (s UpdateS3ResourcesInput) String() string

String returns the string representation

func (*UpdateS3ResourcesInput) Validate 

func (s *UpdateS3ResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 []FailedS3Resource `locationName:"failedS3Resources" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateS3ResourcesOutput) String 

func (s UpdateS3ResourcesOutput) String() string

String returns the string representation

type UpdateS3ResourcesRequest 

type UpdateS3ResourcesRequest struct {
	*aws.Request
	Input *UpdateS3ResourcesInput
	Copy  func(*UpdateS3ResourcesInput) UpdateS3ResourcesRequest
}

UpdateS3ResourcesRequest is the request type for the UpdateS3Resources API operation.

func (UpdateS3ResourcesRequest) Send 

func (r UpdateS3ResourcesRequest) Send(ctx context.Context) (*UpdateS3ResourcesResponse, error)

Send marshals and sends the UpdateS3Resources API request.

type UpdateS3ResourcesResponse added in v0.9.0 

type UpdateS3ResourcesResponse struct {
	*UpdateS3ResourcesOutput
	// contains filtered or unexported fields
}

UpdateS3ResourcesResponse is the response type for the UpdateS3Resources API operation.

func (*UpdateS3ResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateS3ResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateS3Resources request.

Source Files

View all Source files

Directories

Path Synopsis
Package macieiface provides an interface to enable mocking the Amazon Macie service client for testing your code.
 Package macieiface provides an interface to enable mocking the Amazon Macie service client for testing your code.

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.