macie

package
v1.14.29 Latest Latest
Warning

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

 Go to latest Published: Jul 18, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Amazon Macie is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie 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 Macie User Guide (https://docs.aws.amazon.com/macie/latest/userguide/what-is-macie.html).

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 contact 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 Macie 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 (
	// S3OneTimeClassificationTypeFull is a S3OneTimeClassificationType enum value
	S3OneTimeClassificationTypeFull = "FULL"

	// S3OneTimeClassificationTypeNone is a S3OneTimeClassificationType enum value
	S3OneTimeClassificationTypeNone = "NONE"
)
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"
)
View Source 
const (
	ServiceName = "Macie" // Name of service.
	EndpointsID = "macie" // ID to lookup a service endpoint with.
	ServiceID   = "Macie" // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// S3ContinuousClassificationTypeFull is a S3ContinuousClassificationType enum value
	S3ContinuousClassificationTypeFull = "FULL"
)

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

func (AssociateMemberAccountInput) GoString 

func (s AssociateMemberAccountInput) GoString() string

GoString returns the string representation

func (*AssociateMemberAccountInput) SetMemberAccountId 

func (s *AssociateMemberAccountInput) SetMemberAccountId(v string) *AssociateMemberAccountInput

SetMemberAccountId sets the MemberAccountId field's value.

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

func (s AssociateMemberAccountOutput) GoString() string

GoString returns the string representation

func (AssociateMemberAccountOutput) String 

func (s AssociateMemberAccountOutput) String() string

String returns the string representation

type AssociateS3ResourcesInput 

type AssociateS3ResourcesInput struct {

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

	// The S3 resources that you want to associate with Amazon Macie 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) GoString 

func (s AssociateS3ResourcesInput) GoString() string

GoString returns the string representation

func (*AssociateS3ResourcesInput) SetMemberAccountId 

func (s *AssociateS3ResourcesInput) SetMemberAccountId(v string) *AssociateS3ResourcesInput

SetMemberAccountId sets the MemberAccountId field's value.

func (*AssociateS3ResourcesInput) SetS3Resources 

func (s *AssociateS3ResourcesInput) SetS3Resources(v []*S3ResourceClassification) *AssociateS3ResourcesInput

SetS3Resources sets the S3Resources field's value.

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

func (s AssociateS3ResourcesOutput) GoString() string

GoString returns the string representation

func (*AssociateS3ResourcesOutput) SetFailedS3Resources 

func (s *AssociateS3ResourcesOutput) SetFailedS3Resources(v []*FailedS3Resource) *AssociateS3ResourcesOutput

SetFailedS3Resources sets the FailedS3Resources field's value.

func (AssociateS3ResourcesOutput) String 

func (s AssociateS3ResourcesOutput) String() string

String returns the string representation

type ClassificationType 

type ClassificationType struct {

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

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

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

func (ClassificationType) GoString 

func (s ClassificationType) GoString() string

GoString returns the string representation

func (*ClassificationType) SetContinuous 

func (s *ClassificationType) SetContinuous(v string) *ClassificationType

SetContinuous sets the Continuous field's value.

func (*ClassificationType) SetOneTime 

func (s *ClassificationType) SetOneTime(v string) *ClassificationType

SetOneTime sets the OneTime field's value.

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 begins performing continuous classification after
	// a bucket is successfully associated with Amazon Macie.
	Continuous *string `locationName:"continuous" type:"string" enum:"S3ContinuousClassificationType"`

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

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

func (ClassificationTypeUpdate) GoString 

func (s ClassificationTypeUpdate) GoString() string

GoString returns the string representation

func (*ClassificationTypeUpdate) SetContinuous 

func (s *ClassificationTypeUpdate) SetContinuous(v string) *ClassificationTypeUpdate

SetContinuous sets the Continuous field's value.

func (*ClassificationTypeUpdate) SetOneTime 

func (s *ClassificationTypeUpdate) SetOneTime(v string) *ClassificationTypeUpdate

SetOneTime sets the OneTime field's value.

func (ClassificationTypeUpdate) String 

func (s ClassificationTypeUpdate) String() string

String returns the string representation

type DisassociateMemberAccountInput 

type DisassociateMemberAccountInput struct {

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

func (DisassociateMemberAccountInput) GoString 

func (s DisassociateMemberAccountInput) GoString() string

GoString returns the string representation

func (*DisassociateMemberAccountInput) SetMemberAccountId 

func (s *DisassociateMemberAccountInput) SetMemberAccountId(v string) *DisassociateMemberAccountInput

SetMemberAccountId sets the MemberAccountId field's value.

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

func (s DisassociateMemberAccountOutput) GoString() string

GoString returns the string representation

func (DisassociateMemberAccountOutput) String 

func (s DisassociateMemberAccountOutput) String() string

String returns the string representation

type DisassociateS3ResourcesInput 

type DisassociateS3ResourcesInput struct {

	// The S3 resources (buckets or prefixes) that you want to remove from being
	// monitored and classified by Amazon Macie.
	//
	// AssociatedS3Resources is a required field
	AssociatedS3Resources []*S3Resource `locationName:"associatedS3Resources" type:"list" required:"true"`

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

func (DisassociateS3ResourcesInput) GoString 

func (s DisassociateS3ResourcesInput) GoString() string

GoString returns the string representation

func (*DisassociateS3ResourcesInput) SetAssociatedS3Resources 

func (s *DisassociateS3ResourcesInput) SetAssociatedS3Resources(v []*S3Resource) *DisassociateS3ResourcesInput

SetAssociatedS3Resources sets the AssociatedS3Resources field's value.

func (*DisassociateS3ResourcesInput) SetMemberAccountId 

func (s *DisassociateS3ResourcesInput) SetMemberAccountId(v string) *DisassociateS3ResourcesInput

SetMemberAccountId sets the MemberAccountId field's value.

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

func (s DisassociateS3ResourcesOutput) GoString() string

GoString returns the string representation

func (*DisassociateS3ResourcesOutput) SetFailedS3Resources 

func (s *DisassociateS3ResourcesOutput) SetFailedS3Resources(v []*FailedS3Resource) *DisassociateS3ResourcesOutput

SetFailedS3Resources sets the FailedS3Resources field's value.

func (DisassociateS3ResourcesOutput) String 

func (s DisassociateS3ResourcesOutput) String() string

String returns the string representation

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

func (s FailedS3Resource) GoString() string

GoString returns the string representation

func (*FailedS3Resource) SetErrorCode 

func (s *FailedS3Resource) SetErrorCode(v string) *FailedS3Resource

SetErrorCode sets the ErrorCode field's value.

func (*FailedS3Resource) SetErrorMessage 

func (s *FailedS3Resource) SetErrorMessage(v string) *FailedS3Resource

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedS3Resource) SetFailedItem 

func (s *FailedS3Resource) SetFailedItem(v *S3Resource) *FailedS3Resource

SetFailedItem sets the FailedItem field's value.

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

func (s ListMemberAccountsInput) GoString() string

GoString returns the string representation

func (*ListMemberAccountsInput) SetMaxResults 

func (s *ListMemberAccountsInput) SetMaxResults(v int64) *ListMemberAccountsInput

SetMaxResults sets the MaxResults field's value.

func (*ListMemberAccountsInput) SetNextToken 

func (s *ListMemberAccountsInput) SetNextToken(v string) *ListMemberAccountsInput

SetNextToken sets the NextToken field's value.

func (ListMemberAccountsInput) String 

func (s ListMemberAccountsInput) String() string

String returns the string representation

type ListMemberAccountsOutput 

type ListMemberAccountsOutput struct {

	// A list of the Amazon Macie 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) GoString 

func (s ListMemberAccountsOutput) GoString() string

GoString returns the string representation

func (*ListMemberAccountsOutput) SetMemberAccounts 

func (s *ListMemberAccountsOutput) SetMemberAccounts(v []*MemberAccount) *ListMemberAccountsOutput

SetMemberAccounts sets the MemberAccounts field's value.

func (*ListMemberAccountsOutput) SetNextToken 

func (s *ListMemberAccountsOutput) SetNextToken(v string) *ListMemberAccountsOutput

SetNextToken sets the NextToken field's value.

func (ListMemberAccountsOutput) String 

func (s ListMemberAccountsOutput) String() string

String returns the string representation

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

func (s ListS3ResourcesInput) GoString() string

GoString returns the string representation

func (*ListS3ResourcesInput) SetMaxResults 

func (s *ListS3ResourcesInput) SetMaxResults(v int64) *ListS3ResourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListS3ResourcesInput) SetMemberAccountId 

func (s *ListS3ResourcesInput) SetMemberAccountId(v string) *ListS3ResourcesInput

SetMemberAccountId sets the MemberAccountId field's value.

func (*ListS3ResourcesInput) SetNextToken 

func (s *ListS3ResourcesInput) SetNextToken(v string) *ListS3ResourcesInput

SetNextToken sets the NextToken field's value.

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

func (s ListS3ResourcesOutput) GoString() string

GoString returns the string representation

func (*ListS3ResourcesOutput) SetNextToken 

func (s *ListS3ResourcesOutput) SetNextToken(v string) *ListS3ResourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListS3ResourcesOutput) SetS3Resources 

func (s *ListS3ResourcesOutput) SetS3Resources(v []*S3ResourceClassification) *ListS3ResourcesOutput

SetS3Resources sets the S3Resources field's value.

func (ListS3ResourcesOutput) String 

func (s ListS3ResourcesOutput) String() string

String returns the string representation

type Macie 

type Macie struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Macie

New creates a new instance of the Macie client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a Macie client from just a session.
svc := macie.New(mySession)

// Create a Macie client with additional configuration
svc := macie.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Macie) AssociateMemberAccount 

func (c *Macie) AssociateMemberAccount(input *AssociateMemberAccountInput) (*AssociateMemberAccountOutput, error)

AssociateMemberAccount API operation for Amazon Macie.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Macie's API operation AssociateMemberAccount for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

  • ErrCodeLimitExceededException "LimitExceededException" The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

  • ErrCodeInternalException "InternalException" Internal server error.

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

func (*Macie) AssociateMemberAccountRequest 

func (c *Macie) AssociateMemberAccountRequest(input *AssociateMemberAccountInput) (req *request.Request, output *AssociateMemberAccountOutput)

AssociateMemberAccountRequest generates a "aws/request.Request" representing the client's request for the AssociateMemberAccount operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateMemberAccount for more information on using the AssociateMemberAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateMemberAccountRequest method.
req, resp := client.AssociateMemberAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Macie) AssociateMemberAccountWithContext 

func (c *Macie) AssociateMemberAccountWithContext(ctx aws.Context, input *AssociateMemberAccountInput, opts ...request.Option) (*AssociateMemberAccountOutput, error)

AssociateMemberAccountWithContext is the same as AssociateMemberAccount with the addition of the ability to pass a context and additional request options.

See AssociateMemberAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) AssociateS3Resources 

func (c *Macie) AssociateS3Resources(input *AssociateS3ResourcesInput) (*AssociateS3ResourcesOutput, error)

AssociateS3Resources API operation for Amazon Macie.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Macie's API operation AssociateS3Resources for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have required permissions to access the requested resource.

  • ErrCodeLimitExceededException "LimitExceededException" The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

  • ErrCodeInternalException "InternalException" Internal server error.

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

func (*Macie) AssociateS3ResourcesRequest 

func (c *Macie) AssociateS3ResourcesRequest(input *AssociateS3ResourcesInput) (req *request.Request, output *AssociateS3ResourcesOutput)

AssociateS3ResourcesRequest generates a "aws/request.Request" representing the client's request for the AssociateS3Resources operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateS3Resources for more information on using the AssociateS3Resources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateS3ResourcesRequest method.
req, resp := client.AssociateS3ResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Macie) AssociateS3ResourcesWithContext 

func (c *Macie) AssociateS3ResourcesWithContext(ctx aws.Context, input *AssociateS3ResourcesInput, opts ...request.Option) (*AssociateS3ResourcesOutput, error)

AssociateS3ResourcesWithContext is the same as AssociateS3Resources with the addition of the ability to pass a context and additional request options.

See AssociateS3Resources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) DisassociateMemberAccount 

func (c *Macie) DisassociateMemberAccount(input *DisassociateMemberAccountInput) (*DisassociateMemberAccountOutput, error)

DisassociateMemberAccount API operation for Amazon Macie.

Removes the specified member account from Amazon Macie.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Macie's API operation DisassociateMemberAccount for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

  • ErrCodeInternalException "InternalException" Internal server error.

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

func (*Macie) DisassociateMemberAccountRequest 

func (c *Macie) DisassociateMemberAccountRequest(input *DisassociateMemberAccountInput) (req *request.Request, output *DisassociateMemberAccountOutput)

DisassociateMemberAccountRequest generates a "aws/request.Request" representing the client's request for the DisassociateMemberAccount operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateMemberAccount for more information on using the DisassociateMemberAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateMemberAccountRequest method.
req, resp := client.DisassociateMemberAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Macie) DisassociateMemberAccountWithContext 

func (c *Macie) DisassociateMemberAccountWithContext(ctx aws.Context, input *DisassociateMemberAccountInput, opts ...request.Option) (*DisassociateMemberAccountOutput, error)

DisassociateMemberAccountWithContext is the same as DisassociateMemberAccount with the addition of the ability to pass a context and additional request options.

See DisassociateMemberAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) DisassociateS3Resources 

func (c *Macie) DisassociateS3Resources(input *DisassociateS3ResourcesInput) (*DisassociateS3ResourcesOutput, error)

DisassociateS3Resources API operation for Amazon Macie.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Macie's API operation DisassociateS3Resources for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have required permissions to access the requested resource.

  • ErrCodeInternalException "InternalException" Internal server error.

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

func (*Macie) DisassociateS3ResourcesRequest 

func (c *Macie) DisassociateS3ResourcesRequest(input *DisassociateS3ResourcesInput) (req *request.Request, output *DisassociateS3ResourcesOutput)

DisassociateS3ResourcesRequest generates a "aws/request.Request" representing the client's request for the DisassociateS3Resources operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateS3Resources for more information on using the DisassociateS3Resources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateS3ResourcesRequest method.
req, resp := client.DisassociateS3ResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Macie) DisassociateS3ResourcesWithContext 

func (c *Macie) DisassociateS3ResourcesWithContext(ctx aws.Context, input *DisassociateS3ResourcesInput, opts ...request.Option) (*DisassociateS3ResourcesOutput, error)

DisassociateS3ResourcesWithContext is the same as DisassociateS3Resources with the addition of the ability to pass a context and additional request options.

See DisassociateS3Resources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) ListMemberAccounts 

func (c *Macie) ListMemberAccounts(input *ListMemberAccountsInput) (*ListMemberAccountsOutput, error)

ListMemberAccounts API operation for Amazon Macie.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Macie's API operation ListMemberAccounts for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" Internal server error.

  • ErrCodeInvalidInputException "InvalidInputException" The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

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

func (*Macie) ListMemberAccountsPages 

func (c *Macie) ListMemberAccountsPages(input *ListMemberAccountsInput, fn func(*ListMemberAccountsOutput, bool) bool) error

ListMemberAccountsPages iterates over the pages of a ListMemberAccounts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMemberAccounts method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListMemberAccounts operation.
pageNum := 0
err := client.ListMemberAccountsPages(params,
    func(page *ListMemberAccountsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Macie) ListMemberAccountsPagesWithContext 

func (c *Macie) ListMemberAccountsPagesWithContext(ctx aws.Context, input *ListMemberAccountsInput, fn func(*ListMemberAccountsOutput, bool) bool, opts ...request.Option) error

ListMemberAccountsPagesWithContext same as ListMemberAccountsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) ListMemberAccountsRequest 

func (c *Macie) ListMemberAccountsRequest(input *ListMemberAccountsInput) (req *request.Request, output *ListMemberAccountsOutput)

ListMemberAccountsRequest generates a "aws/request.Request" representing the client's request for the ListMemberAccounts operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMemberAccounts for more information on using the ListMemberAccounts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListMemberAccountsRequest method.
req, resp := client.ListMemberAccountsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Macie) ListMemberAccountsWithContext 

func (c *Macie) ListMemberAccountsWithContext(ctx aws.Context, input *ListMemberAccountsInput, opts ...request.Option) (*ListMemberAccountsOutput, error)

ListMemberAccountsWithContext is the same as ListMemberAccounts with the addition of the ability to pass a context and additional request options.

See ListMemberAccounts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) ListS3Resources 

func (c *Macie) ListS3Resources(input *ListS3ResourcesInput) (*ListS3ResourcesOutput, error)

ListS3Resources API operation for Amazon Macie.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Macie's API operation ListS3Resources for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have required permissions to access the requested resource.

  • ErrCodeInternalException "InternalException" Internal server error.

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

func (*Macie) ListS3ResourcesPages 

func (c *Macie) ListS3ResourcesPages(input *ListS3ResourcesInput, fn func(*ListS3ResourcesOutput, bool) bool) error

ListS3ResourcesPages iterates over the pages of a ListS3Resources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListS3Resources method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListS3Resources operation.
pageNum := 0
err := client.ListS3ResourcesPages(params,
    func(page *ListS3ResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Macie) ListS3ResourcesPagesWithContext 

func (c *Macie) ListS3ResourcesPagesWithContext(ctx aws.Context, input *ListS3ResourcesInput, fn func(*ListS3ResourcesOutput, bool) bool, opts ...request.Option) error

ListS3ResourcesPagesWithContext same as ListS3ResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) ListS3ResourcesRequest 

func (c *Macie) ListS3ResourcesRequest(input *ListS3ResourcesInput) (req *request.Request, output *ListS3ResourcesOutput)

ListS3ResourcesRequest generates a "aws/request.Request" representing the client's request for the ListS3Resources operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListS3Resources for more information on using the ListS3Resources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListS3ResourcesRequest method.
req, resp := client.ListS3ResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Macie) ListS3ResourcesWithContext 

func (c *Macie) ListS3ResourcesWithContext(ctx aws.Context, input *ListS3ResourcesInput, opts ...request.Option) (*ListS3ResourcesOutput, error)

ListS3ResourcesWithContext is the same as ListS3Resources with the addition of the ability to pass a context and additional request options.

See ListS3Resources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Macie) UpdateS3Resources 

func (c *Macie) UpdateS3Resources(input *UpdateS3ResourcesInput) (*UpdateS3ResourcesOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Macie's API operation UpdateS3Resources for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInputException "InvalidInputException" The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

  • ErrCodeAccessDeniedException "AccessDeniedException" You do not have required permissions to access the requested resource.

  • ErrCodeInternalException "InternalException" Internal server error.

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

func (*Macie) UpdateS3ResourcesRequest 

func (c *Macie) UpdateS3ResourcesRequest(input *UpdateS3ResourcesInput) (req *request.Request, output *UpdateS3ResourcesOutput)

UpdateS3ResourcesRequest generates a "aws/request.Request" representing the client's request for the UpdateS3Resources operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateS3Resources for more information on using the UpdateS3Resources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateS3ResourcesRequest method.
req, resp := client.UpdateS3ResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Macie) UpdateS3ResourcesWithContext 

func (c *Macie) UpdateS3ResourcesWithContext(ctx aws.Context, input *UpdateS3ResourcesInput, opts ...request.Option) (*UpdateS3ResourcesOutput, error)

UpdateS3ResourcesWithContext is the same as UpdateS3Resources with the addition of the ability to pass a context and additional request options.

See UpdateS3Resources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type MemberAccount 

type MemberAccount struct {

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

Contains information about the Amazon Macie member account.

func (MemberAccount) GoString 

func (s MemberAccount) GoString() string

GoString returns the string representation

func (*MemberAccount) SetAccountId 

func (s *MemberAccount) SetAccountId(v string) *MemberAccount

SetAccountId sets the AccountId field's value.

func (MemberAccount) String 

func (s MemberAccount) String() string

String returns the string representation

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

func (s S3Resource) GoString() string

GoString returns the string representation

func (*S3Resource) SetBucketName 

func (s *S3Resource) SetBucketName(v string) *S3Resource

SetBucketName sets the BucketName field's value.

func (*S3Resource) SetPrefix 

func (s *S3Resource) SetPrefix(v string) *S3Resource

SetPrefix sets the Prefix field's value.

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

The S3 resources that you want to associate with Amazon Macie 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) GoString 

func (s S3ResourceClassification) GoString() string

GoString returns the string representation

func (*S3ResourceClassification) SetBucketName 

func (s *S3ResourceClassification) SetBucketName(v string) *S3ResourceClassification

SetBucketName sets the BucketName field's value.

func (*S3ResourceClassification) SetClassificationType 

func (s *S3ResourceClassification) SetClassificationType(v *ClassificationType) *S3ResourceClassification

SetClassificationType sets the ClassificationType field's value.

func (*S3ResourceClassification) SetPrefix 

func (s *S3ResourceClassification) SetPrefix(v string) *S3ResourceClassification

SetPrefix sets the Prefix field's value.

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

func (s S3ResourceClassificationUpdate) GoString() string

GoString returns the string representation

func (*S3ResourceClassificationUpdate) SetBucketName 

func (s *S3ResourceClassificationUpdate) SetBucketName(v string) *S3ResourceClassificationUpdate

SetBucketName sets the BucketName field's value.

func (*S3ResourceClassificationUpdate) SetClassificationTypeUpdate 

func (s *S3ResourceClassificationUpdate) SetClassificationTypeUpdate(v *ClassificationTypeUpdate) *S3ResourceClassificationUpdate

SetClassificationTypeUpdate sets the ClassificationTypeUpdate field's value.

func (*S3ResourceClassificationUpdate) SetPrefix 

func (s *S3ResourceClassificationUpdate) SetPrefix(v string) *S3ResourceClassificationUpdate

SetPrefix sets the Prefix field's value.

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

func (s UpdateS3ResourcesInput) GoString() string

GoString returns the string representation

func (*UpdateS3ResourcesInput) SetMemberAccountId 

func (s *UpdateS3ResourcesInput) SetMemberAccountId(v string) *UpdateS3ResourcesInput

SetMemberAccountId sets the MemberAccountId field's value.

func (*UpdateS3ResourcesInput) SetS3ResourcesUpdate 

func (s *UpdateS3ResourcesInput) SetS3ResourcesUpdate(v []*S3ResourceClassificationUpdate) *UpdateS3ResourcesInput

SetS3ResourcesUpdate sets the S3ResourcesUpdate field's value.

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

func (s UpdateS3ResourcesOutput) GoString() string

GoString returns the string representation

func (*UpdateS3ResourcesOutput) SetFailedS3Resources 

func (s *UpdateS3ResourcesOutput) SetFailedS3Resources(v []*FailedS3Resource) *UpdateS3ResourcesOutput

SetFailedS3Resources sets the FailedS3Resources field's value.

func (UpdateS3ResourcesOutput) String 

func (s UpdateS3ResourcesOutput) String() string

String returns the string representation

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.