detective

package
v1.29.9 Latest Latest
Warning

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

 Go to latest Published: Feb 24, 2020 License: Apache-2.0 Imports: 10 Imported by: 20

Documentation

Overview

Package detective provides the client and types for making API requests to Amazon Detective.

Amazon Detective is currently in preview. The Detective API can only be used by accounts that are admitted into the preview.

Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.

The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.

Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.

A Detective master account can use the Detective API to do the following:

  • Enable and disable Detective. Enabling Detective creates a new behavior graph.

  • View the list of member accounts in a behavior graph.

  • Add member accounts to a behavior graph.

  • Remove member accounts from a behavior graph.

A member account can use the Detective API to do the following:

  • View the list of behavior graphs that they are invited to.

  • Accept an invitation to contribute to a behavior graph.

  • Decline an invitation to contribute to a behavior graph.

  • Remove their account from a behavior graph.

All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail (https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html).

See https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26 for more information on this service.

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

Using the Client

To contact Amazon Detective 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 Detective client Detective for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/detective/#New

Index

Constants

View Source 
const (
	// MemberStatusInvited is a MemberStatus enum value
	MemberStatusInvited = "INVITED"

	// MemberStatusVerificationInProgress is a MemberStatus enum value
	MemberStatusVerificationInProgress = "VERIFICATION_IN_PROGRESS"

	// MemberStatusVerificationFailed is a MemberStatus enum value
	MemberStatusVerificationFailed = "VERIFICATION_FAILED"

	// MemberStatusEnabled is a MemberStatus enum value
	MemberStatusEnabled = "ENABLED"
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request attempted an invalid action.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request was valid but failed because of a problem with the service.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request refers to a nonexistent resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// This request would cause the number of member accounts in the behavior graph
	// to exceed the maximum allowed. A behavior graph cannot have more than 1000
	// member accounts.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The request parameters are invalid.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Detective"     // Name of service.
	EndpointsID = "api.detective" // ID to lookup a service endpoint with.
	ServiceID   = "Detective"     // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceptInvitationInput 

type AcceptInvitationInput struct {

	// The ARN of the behavior graph that the member account is accepting the invitation
	// for.
	//
	// The member account status in the behavior graph must be INVITED.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AcceptInvitationInput) GoString 

func (s AcceptInvitationInput) GoString() string

GoString returns the string representation

func (*AcceptInvitationInput) SetGraphArn 

func (s *AcceptInvitationInput) SetGraphArn(v string) *AcceptInvitationInput

SetGraphArn sets the GraphArn field's value.

func (AcceptInvitationInput) String 

func (s AcceptInvitationInput) String() string

String returns the string representation

func (*AcceptInvitationInput) Validate 

func (s *AcceptInvitationInput) Validate() error

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

type AcceptInvitationOutput 

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

func (AcceptInvitationOutput) GoString 

func (s AcceptInvitationOutput) GoString() string

GoString returns the string representation

func (AcceptInvitationOutput) String 

func (s AcceptInvitationOutput) String() string

String returns the string representation

type Account 

type Account struct {

	// The account identifier of the AWS account.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The AWS account root user email address for the AWS account.
	//
	// EmailAddress is a required field
	EmailAddress *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Amazon Detective is currently in preview.

An AWS account that is the master of or a member of a behavior graph.

func (Account) GoString 

func (s Account) GoString() string

GoString returns the string representation

func (*Account) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*Account) SetEmailAddress 

func (s *Account) SetEmailAddress(v string) *Account

SetEmailAddress sets the EmailAddress field's value.

func (Account) String 

func (s Account) String() string

String returns the string representation

func (*Account) Validate 

func (s *Account) Validate() error

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

type ConflictException added in v1.28.0 

type ConflictException struct {
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request attempted an invalid action.

func (ConflictException) Code added in v1.28.0 

func (s ConflictException) Code() string

Code returns the exception type name.

func (ConflictException) Error added in v1.28.0 

func (s ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

func (s ConflictException) GoString() string

GoString returns the string representation

func (ConflictException) Message added in v1.28.0 

func (s ConflictException) Message() string

Message returns the exception's message.

func (ConflictException) OrigErr added in v1.28.0 

func (s ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ConflictException) RequestID added in v1.28.0 

func (s ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ConflictException) StatusCode added in v1.28.0 

func (s ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.28.0 

func (s ConflictException) String() string

String returns the string representation

type CreateGraphInput 

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

func (CreateGraphInput) GoString 

func (s CreateGraphInput) GoString() string

GoString returns the string representation

func (CreateGraphInput) String 

func (s CreateGraphInput) String() string

String returns the string representation

type CreateGraphOutput 

type CreateGraphOutput struct {

	// The ARN of the new behavior graph.
	GraphArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateGraphOutput) GoString 

func (s CreateGraphOutput) GoString() string

GoString returns the string representation

func (*CreateGraphOutput) SetGraphArn 

func (s *CreateGraphOutput) SetGraphArn(v string) *CreateGraphOutput

SetGraphArn sets the GraphArn field's value.

func (CreateGraphOutput) String 

func (s CreateGraphOutput) String() string

String returns the string representation

type CreateMembersInput 

type CreateMembersInput struct {

	// The list of AWS accounts to invite to become member accounts in the behavior
	// graph. For each invited account, the account list contains the account identifier
	// and the AWS account root user email address.
	//
	// Accounts is a required field
	Accounts []*Account `min:"1" type:"list" required:"true"`

	// The ARN of the behavior graph to invite the member accounts to contribute
	// their data to.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`

	// Customized message text to include in the invitation email message to the
	// invited member accounts.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateMembersInput) GoString 

func (s CreateMembersInput) GoString() string

GoString returns the string representation

func (*CreateMembersInput) SetAccounts 

func (s *CreateMembersInput) SetAccounts(v []*Account) *CreateMembersInput

SetAccounts sets the Accounts field's value.

func (*CreateMembersInput) SetGraphArn 

func (s *CreateMembersInput) SetGraphArn(v string) *CreateMembersInput

SetGraphArn sets the GraphArn field's value.

func (*CreateMembersInput) SetMessage 

func (s *CreateMembersInput) SetMessage(v string) *CreateMembersInput

SetMessage sets the Message field's value.

func (CreateMembersInput) String 

func (s CreateMembersInput) String() string

String returns the string representation

func (*CreateMembersInput) Validate 

func (s *CreateMembersInput) Validate() error

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

type CreateMembersOutput 

type CreateMembersOutput struct {

	// The set of member account invitation requests that Detective was able to
	// process. This includes accounts that are being verified, that failed verification,
	// and that passed verification and are being sent an invitation.
	Members []*MemberDetail `type:"list"`

	// The list of accounts for which Detective was unable to process the invitation
	// request. For each account, the list provides the reason why the request could
	// not be processed. The list includes accounts that are already member accounts
	// in the behavior graph.
	UnprocessedAccounts []*UnprocessedAccount `type:"list"`
	// contains filtered or unexported fields
}

func (CreateMembersOutput) GoString 

func (s CreateMembersOutput) GoString() string

GoString returns the string representation

func (*CreateMembersOutput) SetMembers 

func (s *CreateMembersOutput) SetMembers(v []*MemberDetail) *CreateMembersOutput

SetMembers sets the Members field's value.

func (*CreateMembersOutput) SetUnprocessedAccounts 

func (s *CreateMembersOutput) SetUnprocessedAccounts(v []*UnprocessedAccount) *CreateMembersOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (CreateMembersOutput) String 

func (s CreateMembersOutput) String() string

String returns the string representation

type DeleteGraphInput 

type DeleteGraphInput struct {

	// The ARN of the behavior graph to disable.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGraphInput) GoString 

func (s DeleteGraphInput) GoString() string

GoString returns the string representation

func (*DeleteGraphInput) SetGraphArn 

func (s *DeleteGraphInput) SetGraphArn(v string) *DeleteGraphInput

SetGraphArn sets the GraphArn field's value.

func (DeleteGraphInput) String 

func (s DeleteGraphInput) String() string

String returns the string representation

func (*DeleteGraphInput) Validate 

func (s *DeleteGraphInput) Validate() error

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

type DeleteGraphOutput 

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

func (DeleteGraphOutput) GoString 

func (s DeleteGraphOutput) GoString() string

GoString returns the string representation

func (DeleteGraphOutput) String 

func (s DeleteGraphOutput) String() string

String returns the string representation

type DeleteMembersInput 

type DeleteMembersInput struct {

	// The list of AWS account identifiers for the member accounts to delete from
	// the behavior graph.
	//
	// AccountIds is a required field
	AccountIds []*string `min:"1" type:"list" required:"true"`

	// The ARN of the behavior graph to delete members from.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMembersInput) GoString 

func (s DeleteMembersInput) GoString() string

GoString returns the string representation

func (*DeleteMembersInput) SetAccountIds 

func (s *DeleteMembersInput) SetAccountIds(v []*string) *DeleteMembersInput

SetAccountIds sets the AccountIds field's value.

func (*DeleteMembersInput) SetGraphArn 

func (s *DeleteMembersInput) SetGraphArn(v string) *DeleteMembersInput

SetGraphArn sets the GraphArn field's value.

func (DeleteMembersInput) String 

func (s DeleteMembersInput) String() string

String returns the string representation

func (*DeleteMembersInput) Validate 

func (s *DeleteMembersInput) Validate() error

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

type DeleteMembersOutput 

type DeleteMembersOutput struct {

	// The list of AWS account identifiers for the member accounts that Detective
	// successfully deleted from the behavior graph.
	AccountIds []*string `min:"1" type:"list"`

	// The list of member accounts that Detective was not able to delete from the
	// behavior graph. For each member account, provides the reason that the deletion
	// could not be processed.
	UnprocessedAccounts []*UnprocessedAccount `type:"list"`
	// contains filtered or unexported fields
}

func (DeleteMembersOutput) GoString 

func (s DeleteMembersOutput) GoString() string

GoString returns the string representation

func (*DeleteMembersOutput) SetAccountIds 

func (s *DeleteMembersOutput) SetAccountIds(v []*string) *DeleteMembersOutput

SetAccountIds sets the AccountIds field's value.

func (*DeleteMembersOutput) SetUnprocessedAccounts 

func (s *DeleteMembersOutput) SetUnprocessedAccounts(v []*UnprocessedAccount) *DeleteMembersOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (DeleteMembersOutput) String 

func (s DeleteMembersOutput) String() string

String returns the string representation

type Detective 

type Detective struct {
	*client.Client
}

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

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

New creates a new instance of the Detective 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: 

mySession := session.Must(session.NewSession())

// Create a Detective client from just a session.
svc := detective.New(mySession)

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

func (*Detective) AcceptInvitation 

func (c *Detective) AcceptInvitation(input *AcceptInvitationInput) (*AcceptInvitationOutput, error)

AcceptInvitation API operation for Amazon Detective.

Amazon Detective is currently in preview.

Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.

The request provides the ARN of behavior graph.

The member account status in the graph must be INVITED.

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 Detective's API operation AcceptInvitation for usage and error information.

Returned Error Types:

  • ConflictException The request attempted an invalid action.

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/AcceptInvitation

func (*Detective) AcceptInvitationRequest 

func (c *Detective) AcceptInvitationRequest(input *AcceptInvitationInput) (req *request.Request, output *AcceptInvitationOutput)

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

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 AcceptInvitation for more information on using the AcceptInvitation 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 AcceptInvitationRequest method.
req, resp := client.AcceptInvitationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/AcceptInvitation

func (*Detective) AcceptInvitationWithContext 

func (c *Detective) AcceptInvitationWithContext(ctx aws.Context, input *AcceptInvitationInput, opts ...request.Option) (*AcceptInvitationOutput, error)

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

See AcceptInvitation 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 (*Detective) CreateGraph 

func (c *Detective) CreateGraph(input *CreateGraphInput) (*CreateGraphOutput, error)

CreateGraph API operation for Amazon Detective.

Amazon Detective is currently in preview.

Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective.

The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.

CreateGraph triggers a process to create the corresponding data tables for the new behavior graph.

An account can only be the master account for one behavior graph within a Region. If the same account calls CreateGraph with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.

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 Detective's API operation CreateGraph for usage and error information.

Returned Error Types:

  • ConflictException The request attempted an invalid action.

  • InternalServerException The request was valid but failed because of a problem with the service.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/CreateGraph

func (*Detective) CreateGraphRequest 

func (c *Detective) CreateGraphRequest(input *CreateGraphInput) (req *request.Request, output *CreateGraphOutput)

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

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 CreateGraph for more information on using the CreateGraph 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 CreateGraphRequest method.
req, resp := client.CreateGraphRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/CreateGraph

func (*Detective) CreateGraphWithContext 

func (c *Detective) CreateGraphWithContext(ctx aws.Context, input *CreateGraphInput, opts ...request.Option) (*CreateGraphOutput, error)

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

See CreateGraph 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 (*Detective) CreateMembers 

func (c *Detective) CreateMembers(input *CreateMembersInput) (*CreateMembersOutput, error)

CreateMembers API operation for Amazon Detective.

Amazon Detective is currently in preview.

Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph.

CreateMembers verifies the accounts and then sends invitations to the verified accounts.

The request provides the behavior graph ARN and the list of accounts to invite.

The response separates the requested accounts into two lists:

  • The accounts that CreateMembers was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.

  • The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.

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 Detective's API operation CreateMembers for usage and error information.

Returned Error Types:

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

  • ServiceQuotaExceededException This request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/CreateMembers

func (*Detective) CreateMembersRequest 

func (c *Detective) CreateMembersRequest(input *CreateMembersInput) (req *request.Request, output *CreateMembersOutput)

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

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 CreateMembers for more information on using the CreateMembers 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 CreateMembersRequest method.
req, resp := client.CreateMembersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/CreateMembers

func (*Detective) CreateMembersWithContext 

func (c *Detective) CreateMembersWithContext(ctx aws.Context, input *CreateMembersInput, opts ...request.Option) (*CreateMembersOutput, error)

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

See CreateMembers 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 (*Detective) DeleteGraph 

func (c *Detective) DeleteGraph(input *DeleteGraphInput) (*DeleteGraphOutput, error)

DeleteGraph API operation for Amazon Detective.

Amazon Detective is currently in preview.

Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.

DeleteGraph can only be called by the master account for a behavior graph.

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 Detective's API operation DeleteGraph for usage and error information.

Returned Error Types:

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/DeleteGraph

func (*Detective) DeleteGraphRequest 

func (c *Detective) DeleteGraphRequest(input *DeleteGraphInput) (req *request.Request, output *DeleteGraphOutput)

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

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 DeleteGraph for more information on using the DeleteGraph 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 DeleteGraphRequest method.
req, resp := client.DeleteGraphRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/DeleteGraph

func (*Detective) DeleteGraphWithContext 

func (c *Detective) DeleteGraphWithContext(ctx aws.Context, input *DeleteGraphInput, opts ...request.Option) (*DeleteGraphOutput, error)

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

See DeleteGraph 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 (*Detective) DeleteMembers 

func (c *Detective) DeleteMembers(input *DeleteMembersInput) (*DeleteMembersOutput, error)

DeleteMembers API operation for Amazon Detective.

Amazon Detective is currently in preview.

Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use DeleteMembers to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the DeleteGraph API method.

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 Detective's API operation DeleteMembers for usage and error information.

Returned Error Types:

  • ConflictException The request attempted an invalid action.

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/DeleteMembers

func (*Detective) DeleteMembersRequest 

func (c *Detective) DeleteMembersRequest(input *DeleteMembersInput) (req *request.Request, output *DeleteMembersOutput)

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

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 DeleteMembers for more information on using the DeleteMembers 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 DeleteMembersRequest method.
req, resp := client.DeleteMembersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/DeleteMembers

func (*Detective) DeleteMembersWithContext 

func (c *Detective) DeleteMembersWithContext(ctx aws.Context, input *DeleteMembersInput, opts ...request.Option) (*DeleteMembersOutput, error)

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

See DeleteMembers 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 (*Detective) DisassociateMembership 

func (c *Detective) DisassociateMembership(input *DisassociateMembershipInput) (*DisassociateMembershipOutput, error)

DisassociateMembership API operation for Amazon Detective.

Amazon Detective is currently in preview.

Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the ENABLED status.

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 Detective's API operation DisassociateMembership for usage and error information.

Returned Error Types:

  • ConflictException The request attempted an invalid action.

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/DisassociateMembership

func (*Detective) DisassociateMembershipRequest 

func (c *Detective) DisassociateMembershipRequest(input *DisassociateMembershipInput) (req *request.Request, output *DisassociateMembershipOutput)

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

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 DisassociateMembership for more information on using the DisassociateMembership 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 DisassociateMembershipRequest method.
req, resp := client.DisassociateMembershipRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/DisassociateMembership

func (*Detective) DisassociateMembershipWithContext 

func (c *Detective) DisassociateMembershipWithContext(ctx aws.Context, input *DisassociateMembershipInput, opts ...request.Option) (*DisassociateMembershipOutput, error)

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

See DisassociateMembership 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 (*Detective) GetMembers 

func (c *Detective) GetMembers(input *GetMembersInput) (*GetMembersOutput, error)

GetMembers API operation for Amazon Detective.

Amazon Detective is currently in preview.

Returns the membership details for specified member accounts for a behavior graph.

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 Detective's API operation GetMembers for usage and error information.

Returned Error Types:

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/GetMembers

func (*Detective) GetMembersRequest 

func (c *Detective) GetMembersRequest(input *GetMembersInput) (req *request.Request, output *GetMembersOutput)

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

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 GetMembers for more information on using the GetMembers 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 GetMembersRequest method.
req, resp := client.GetMembersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/GetMembers

func (*Detective) GetMembersWithContext 

func (c *Detective) GetMembersWithContext(ctx aws.Context, input *GetMembersInput, opts ...request.Option) (*GetMembersOutput, error)

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

See GetMembers 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 (*Detective) ListGraphs 

func (c *Detective) ListGraphs(input *ListGraphsInput) (*ListGraphsOutput, error)

ListGraphs API operation for Amazon Detective.

Amazon Detective is currently in preview.

Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.

Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.

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 Detective's API operation ListGraphs for usage and error information.

Returned Error Types:

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/ListGraphs

func (*Detective) ListGraphsPages 

func (c *Detective) ListGraphsPages(input *ListGraphsInput, fn func(*ListGraphsOutput, bool) bool) error

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

See ListGraphs 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 ListGraphs operation.
pageNum := 0
err := client.ListGraphsPages(params,
    func(page *detective.ListGraphsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Detective) ListGraphsPagesWithContext 

func (c *Detective) ListGraphsPagesWithContext(ctx aws.Context, input *ListGraphsInput, fn func(*ListGraphsOutput, bool) bool, opts ...request.Option) error

ListGraphsPagesWithContext same as ListGraphsPages 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 (*Detective) ListGraphsRequest 

func (c *Detective) ListGraphsRequest(input *ListGraphsInput) (req *request.Request, output *ListGraphsOutput)

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

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 ListGraphs for more information on using the ListGraphs 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 ListGraphsRequest method.
req, resp := client.ListGraphsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/ListGraphs

func (*Detective) ListGraphsWithContext 

func (c *Detective) ListGraphsWithContext(ctx aws.Context, input *ListGraphsInput, opts ...request.Option) (*ListGraphsOutput, error)

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

See ListGraphs 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 (*Detective) ListInvitations 

func (c *Detective) ListInvitations(input *ListInvitationsInput) (*ListInvitationsOutput, error)

ListInvitations API operation for Amazon Detective.

Amazon Detective is currently in preview.

Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a member account.

Open invitations are invitations that the member account has not responded to.

The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.

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 Detective's API operation ListInvitations for usage and error information.

Returned Error Types:

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/ListInvitations

func (*Detective) ListInvitationsPages 

func (c *Detective) ListInvitationsPages(input *ListInvitationsInput, fn func(*ListInvitationsOutput, bool) bool) error

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

See ListInvitations 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 ListInvitations operation.
pageNum := 0
err := client.ListInvitationsPages(params,
    func(page *detective.ListInvitationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Detective) ListInvitationsPagesWithContext 

func (c *Detective) ListInvitationsPagesWithContext(ctx aws.Context, input *ListInvitationsInput, fn func(*ListInvitationsOutput, bool) bool, opts ...request.Option) error

ListInvitationsPagesWithContext same as ListInvitationsPages 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 (*Detective) ListInvitationsRequest 

func (c *Detective) ListInvitationsRequest(input *ListInvitationsInput) (req *request.Request, output *ListInvitationsOutput)

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

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 ListInvitations for more information on using the ListInvitations 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 ListInvitationsRequest method.
req, resp := client.ListInvitationsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/ListInvitations

func (*Detective) ListInvitationsWithContext 

func (c *Detective) ListInvitationsWithContext(ctx aws.Context, input *ListInvitationsInput, opts ...request.Option) (*ListInvitationsOutput, error)

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

See ListInvitations 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 (*Detective) ListMembers 

func (c *Detective) ListMembers(input *ListMembersInput) (*ListMembersOutput, error)

ListMembers API operation for Amazon Detective.

Amazon Detective is currently in preview.

Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.

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 Detective's API operation ListMembers for usage and error information.

Returned Error Types:

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/ListMembers

func (*Detective) ListMembersPages 

func (c *Detective) ListMembersPages(input *ListMembersInput, fn func(*ListMembersOutput, bool) bool) error

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

See ListMembers 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 ListMembers operation.
pageNum := 0
err := client.ListMembersPages(params,
    func(page *detective.ListMembersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Detective) ListMembersPagesWithContext 

func (c *Detective) ListMembersPagesWithContext(ctx aws.Context, input *ListMembersInput, fn func(*ListMembersOutput, bool) bool, opts ...request.Option) error

ListMembersPagesWithContext same as ListMembersPages 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 (*Detective) ListMembersRequest 

func (c *Detective) ListMembersRequest(input *ListMembersInput) (req *request.Request, output *ListMembersOutput)

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

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 ListMembers for more information on using the ListMembers 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 ListMembersRequest method.
req, resp := client.ListMembersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/ListMembers

func (*Detective) ListMembersWithContext 

func (c *Detective) ListMembersWithContext(ctx aws.Context, input *ListMembersInput, opts ...request.Option) (*ListMembersOutput, error)

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

See ListMembers 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 (*Detective) RejectInvitation 

func (c *Detective) RejectInvitation(input *RejectInvitationInput) (*RejectInvitationOutput, error)

RejectInvitation API operation for Amazon Detective.

Amazon Detective is currently in preview.

Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a member account that has the INVITED status.

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 Detective's API operation RejectInvitation for usage and error information.

Returned Error Types:

  • ConflictException The request attempted an invalid action.

  • InternalServerException The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException The request refers to a nonexistent resource.

  • ValidationException The request parameters are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/RejectInvitation

func (*Detective) RejectInvitationRequest 

func (c *Detective) RejectInvitationRequest(input *RejectInvitationInput) (req *request.Request, output *RejectInvitationOutput)

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

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 RejectInvitation for more information on using the RejectInvitation 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 RejectInvitationRequest method.
req, resp := client.RejectInvitationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/detective-2018-10-26/RejectInvitation

func (*Detective) RejectInvitationWithContext 

func (c *Detective) RejectInvitationWithContext(ctx aws.Context, input *RejectInvitationInput, opts ...request.Option) (*RejectInvitationOutput, error)

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

See RejectInvitation 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 DisassociateMembershipInput 

type DisassociateMembershipInput struct {

	// The ARN of the behavior graph to remove the member account from.
	//
	// The member account's member status in the behavior graph must be ENABLED.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateMembershipInput) GoString 

func (s DisassociateMembershipInput) GoString() string

GoString returns the string representation

func (*DisassociateMembershipInput) SetGraphArn 

func (s *DisassociateMembershipInput) SetGraphArn(v string) *DisassociateMembershipInput

SetGraphArn sets the GraphArn field's value.

func (DisassociateMembershipInput) String 

func (s DisassociateMembershipInput) String() string

String returns the string representation

func (*DisassociateMembershipInput) Validate 

func (s *DisassociateMembershipInput) Validate() error

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

type DisassociateMembershipOutput 

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

func (DisassociateMembershipOutput) GoString 

func (s DisassociateMembershipOutput) GoString() string

GoString returns the string representation

func (DisassociateMembershipOutput) String 

func (s DisassociateMembershipOutput) String() string

String returns the string representation

type GetMembersInput 

type GetMembersInput struct {

	// The list of AWS account identifiers for the member account for which to return
	// member details.
	//
	// You cannot use GetMembers to retrieve information about member accounts that
	// were removed from the behavior graph.
	//
	// AccountIds is a required field
	AccountIds []*string `min:"1" type:"list" required:"true"`

	// The ARN of the behavior graph for which to request the member details.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMembersInput) GoString 

func (s GetMembersInput) GoString() string

GoString returns the string representation

func (*GetMembersInput) SetAccountIds 

func (s *GetMembersInput) SetAccountIds(v []*string) *GetMembersInput

SetAccountIds sets the AccountIds field's value.

func (*GetMembersInput) SetGraphArn 

func (s *GetMembersInput) SetGraphArn(v string) *GetMembersInput

SetGraphArn sets the GraphArn field's value.

func (GetMembersInput) String 

func (s GetMembersInput) String() string

String returns the string representation

func (*GetMembersInput) Validate 

func (s *GetMembersInput) Validate() error

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

type GetMembersOutput 

type GetMembersOutput struct {

	// The member account details that Detective is returning in response to the
	// request.
	MemberDetails []*MemberDetail `type:"list"`

	// The requested member accounts for which Detective was unable to return member
	// details.
	//
	// For each account, provides the reason why the request could not be processed.
	UnprocessedAccounts []*UnprocessedAccount `type:"list"`
	// contains filtered or unexported fields
}

func (GetMembersOutput) GoString 

func (s GetMembersOutput) GoString() string

GoString returns the string representation

func (*GetMembersOutput) SetMemberDetails 

func (s *GetMembersOutput) SetMemberDetails(v []*MemberDetail) *GetMembersOutput

SetMemberDetails sets the MemberDetails field's value.

func (*GetMembersOutput) SetUnprocessedAccounts 

func (s *GetMembersOutput) SetUnprocessedAccounts(v []*UnprocessedAccount) *GetMembersOutput

SetUnprocessedAccounts sets the UnprocessedAccounts field's value.

func (GetMembersOutput) String 

func (s GetMembersOutput) String() string

String returns the string representation

type Graph 

type Graph struct {

	// The ARN of the behavior graph.
	Arn *string `type:"string"`

	// The date and time that the behavior graph was created. The value is in milliseconds
	// since the epoch.
	CreatedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Amazon Detective is currently in preview.

A behavior graph in Detective.

func (Graph) GoString 

func (s Graph) GoString() string

GoString returns the string representation

func (*Graph) SetArn 

func (s *Graph) SetArn(v string) *Graph

SetArn sets the Arn field's value.

func (*Graph) SetCreatedTime 

func (s *Graph) SetCreatedTime(v time.Time) *Graph

SetCreatedTime sets the CreatedTime field's value.

func (Graph) String 

func (s Graph) String() string

String returns the string representation

type InternalServerException added in v1.28.0 

type InternalServerException struct {
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was valid but failed because of a problem with the service.

func (InternalServerException) Code added in v1.28.0 

func (s InternalServerException) Code() string

Code returns the exception type name.

func (InternalServerException) Error added in v1.28.0 

func (s InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (InternalServerException) Message added in v1.28.0 

func (s InternalServerException) Message() string

Message returns the exception's message.

func (InternalServerException) OrigErr added in v1.28.0 

func (s InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (InternalServerException) RequestID added in v1.28.0 

func (s InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (InternalServerException) StatusCode added in v1.28.0 

func (s InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.28.0 

func (s InternalServerException) String() string

String returns the string representation

type ListGraphsInput 

type ListGraphsInput struct {

	// The maximum number of graphs to return at a time. The total must be less
	// than the overall limit on the number of results to return, which is currently
	// 200.
	MaxResults *int64 `min:"1" type:"integer"`

	// For requests to get the next page of results, the pagination token that was
	// returned with the previous set of results. The initial request does not include
	// a pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGraphsInput) GoString 

func (s ListGraphsInput) GoString() string

GoString returns the string representation

func (*ListGraphsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListGraphsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListGraphsInput) String 

func (s ListGraphsInput) String() string

String returns the string representation

func (*ListGraphsInput) Validate 

func (s *ListGraphsInput) Validate() error

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

type ListGraphsOutput 

type ListGraphsOutput struct {

	// A list of behavior graphs that the account is a master for.
	GraphList []*Graph `type:"list"`

	// If there are more behavior graphs remaining in the results, then this is
	// the pagination token to use to request the next page of behavior graphs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGraphsOutput) GoString 

func (s ListGraphsOutput) GoString() string

GoString returns the string representation

func (*ListGraphsOutput) SetGraphList 

func (s *ListGraphsOutput) SetGraphList(v []*Graph) *ListGraphsOutput

SetGraphList sets the GraphList field's value.

func (*ListGraphsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListGraphsOutput) String 

func (s ListGraphsOutput) String() string

String returns the string representation

type ListInvitationsInput 

type ListInvitationsInput struct {

	// The maximum number of behavior graph invitations to return in the response.
	// The total must be less than the overall limit on the number of results to
	// return, which is currently 200.
	MaxResults *int64 `min:"1" type:"integer"`

	// For requests to retrieve the next page of results, the pagination token that
	// was returned with the previous page of results. The initial request does
	// not include a pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListInvitationsInput) GoString 

func (s ListInvitationsInput) GoString() string

GoString returns the string representation

func (*ListInvitationsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListInvitationsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListInvitationsInput) String 

func (s ListInvitationsInput) String() string

String returns the string representation

func (*ListInvitationsInput) Validate 

func (s *ListInvitationsInput) Validate() error

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

type ListInvitationsOutput 

type ListInvitationsOutput struct {

	// The list of behavior graphs for which the member account has open or accepted
	// invitations.
	Invitations []*MemberDetail `type:"list"`

	// If there are more behavior graphs remaining in the results, then this is
	// the pagination token to use to request the next page of behavior graphs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListInvitationsOutput) GoString 

func (s ListInvitationsOutput) GoString() string

GoString returns the string representation

func (*ListInvitationsOutput) SetInvitations 

func (s *ListInvitationsOutput) SetInvitations(v []*MemberDetail) *ListInvitationsOutput

SetInvitations sets the Invitations field's value.

func (*ListInvitationsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListInvitationsOutput) String 

func (s ListInvitationsOutput) String() string

String returns the string representation

type ListMembersInput 

type ListMembersInput struct {

	// The ARN of the behavior graph for which to retrieve the list of member accounts.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`

	// The maximum number of member accounts to include in the response. The total
	// must be less than the overall limit on the number of results to return, which
	// is currently 200.
	MaxResults *int64 `min:"1" type:"integer"`

	// For requests to retrieve the next page of member account results, the pagination
	// token that was returned with the previous page of results. The initial request
	// does not include a pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMembersInput) GoString 

func (s ListMembersInput) GoString() string

GoString returns the string representation

func (*ListMembersInput) SetGraphArn 

func (s *ListMembersInput) SetGraphArn(v string) *ListMembersInput

SetGraphArn sets the GraphArn field's value.

func (*ListMembersInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMembersInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListMembersInput) String 

func (s ListMembersInput) String() string

String returns the string representation

func (*ListMembersInput) Validate 

func (s *ListMembersInput) Validate() error

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

type ListMembersOutput 

type ListMembersOutput struct {

	// The list of member accounts in the behavior graph.
	//
	// The results include member accounts that did not pass verification and member
	// accounts that have not yet accepted the invitation to the behavior graph.
	// The results do not include member accounts that were removed from the behavior
	// graph.
	MemberDetails []*MemberDetail `type:"list"`

	// If there are more member accounts remaining in the results, then this is
	// the pagination token to use to request the next page of member accounts.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListMembersOutput) GoString 

func (s ListMembersOutput) GoString() string

GoString returns the string representation

func (*ListMembersOutput) SetMemberDetails 

func (s *ListMembersOutput) SetMemberDetails(v []*MemberDetail) *ListMembersOutput

SetMemberDetails sets the MemberDetails field's value.

func (*ListMembersOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListMembersOutput) String 

func (s ListMembersOutput) String() string

String returns the string representation

type MemberDetail 

type MemberDetail struct {

	// The AWS account identifier for the member account.
	AccountId *string `min:"12" type:"string"`

	// The AWS account root user email address for the member account.
	EmailAddress *string `min:"1" type:"string"`

	// The ARN of the behavior graph that the member account was invited to.
	GraphArn *string `type:"string"`

	// The date and time that Detective sent the invitation to the member account.
	// The value is in milliseconds since the epoch.
	InvitedTime *time.Time `type:"timestamp"`

	// The AWS account identifier of the master account for the behavior graph.
	MasterId *string `min:"12" type:"string"`

	// The current membership status of the member account. The status can have
	// one of the following values:
	//
	//    * INVITED - Indicates that the member was sent an invitation but has not
	//    yet responded.
	//
	//    * VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that
	//    the account identifier and email address provided for the member account
	//    match. If they do match, then Detective sends the invitation. If the email
	//    address and account identifier don't match, then the member cannot be
	//    added to the behavior graph.
	//
	//    * VERIFICATION_FAILED - Indicates that the account and email address provided
	//    for the member account do not match, and Detective did not send an invitation
	//    to the account.
	//
	//    * ENABLED - Indicates that the member account accepted the invitation
	//    to contribute to the behavior graph.
	//
	// Member accounts that declined an invitation or that were removed from the
	// behavior graph are not included.
	Status *string `type:"string" enum:"MemberStatus"`

	// The date and time that the member account was last updated. The value is
	// in milliseconds since the epoch.
	UpdatedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Amazon Detective is currently in preview.

Details about a member account that was invited to contribute to a behavior graph.

func (MemberDetail) GoString 

func (s MemberDetail) GoString() string

GoString returns the string representation

func (*MemberDetail) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*MemberDetail) SetEmailAddress 

func (s *MemberDetail) SetEmailAddress(v string) *MemberDetail

SetEmailAddress sets the EmailAddress field's value.

func (*MemberDetail) SetGraphArn 

func (s *MemberDetail) SetGraphArn(v string) *MemberDetail

SetGraphArn sets the GraphArn field's value.

func (*MemberDetail) SetInvitedTime 

func (s *MemberDetail) SetInvitedTime(v time.Time) *MemberDetail

SetInvitedTime sets the InvitedTime field's value.

func (*MemberDetail) SetMasterId 

func (s *MemberDetail) SetMasterId(v string) *MemberDetail

SetMasterId sets the MasterId field's value.

func (*MemberDetail) SetStatus 

func (s *MemberDetail) SetStatus(v string) *MemberDetail

SetStatus sets the Status field's value.

func (*MemberDetail) SetUpdatedTime 

func (s *MemberDetail) SetUpdatedTime(v time.Time) *MemberDetail

SetUpdatedTime sets the UpdatedTime field's value.

func (MemberDetail) String 

func (s MemberDetail) String() string

String returns the string representation

type RejectInvitationInput 

type RejectInvitationInput struct {

	// The ARN of the behavior graph to reject the invitation to.
	//
	// The member account's current member status in the behavior graph must be
	// INVITED.
	//
	// GraphArn is a required field
	GraphArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RejectInvitationInput) GoString 

func (s RejectInvitationInput) GoString() string

GoString returns the string representation

func (*RejectInvitationInput) SetGraphArn 

func (s *RejectInvitationInput) SetGraphArn(v string) *RejectInvitationInput

SetGraphArn sets the GraphArn field's value.

func (RejectInvitationInput) String 

func (s RejectInvitationInput) String() string

String returns the string representation

func (*RejectInvitationInput) Validate 

func (s *RejectInvitationInput) Validate() error

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

type RejectInvitationOutput 

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

func (RejectInvitationOutput) GoString 

func (s RejectInvitationOutput) GoString() string

GoString returns the string representation

func (RejectInvitationOutput) String 

func (s RejectInvitationOutput) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request refers to a nonexistent resource.

func (ResourceNotFoundException) Code added in v1.28.0 

func (s ResourceNotFoundException) Code() string

Code returns the exception type name.

func (ResourceNotFoundException) Error added in v1.28.0 

func (s ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (ResourceNotFoundException) Message added in v1.28.0 

func (s ResourceNotFoundException) Message() string

Message returns the exception's message.

func (ResourceNotFoundException) OrigErr added in v1.28.0 

func (s ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ResourceNotFoundException) RequestID added in v1.28.0 

func (s ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ResourceNotFoundException) StatusCode added in v1.28.0 

func (s ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ServiceQuotaExceededException added in v1.28.0 

type ServiceQuotaExceededException struct {
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

This request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.

func (ServiceQuotaExceededException) Code added in v1.28.0 

func (s ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (ServiceQuotaExceededException) Error added in v1.28.0 

func (s ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.28.0 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (ServiceQuotaExceededException) Message added in v1.28.0 

func (s ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (ServiceQuotaExceededException) OrigErr added in v1.28.0 

func (s ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ServiceQuotaExceededException) RequestID added in v1.28.0 

func (s ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ServiceQuotaExceededException) StatusCode added in v1.28.0 

func (s ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String added in v1.28.0 

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type UnprocessedAccount 

type UnprocessedAccount struct {

	// The AWS account identifier of the member account that was not processed.
	AccountId *string `min:"12" type:"string"`

	// The reason that the member account request could not be processed.
	Reason *string `type:"string"`
	// contains filtered or unexported fields
}

Amazon Detective is currently in preview.

A member account that was included in a request but for which the request could not be processed.

func (UnprocessedAccount) GoString 

func (s UnprocessedAccount) GoString() string

GoString returns the string representation

func (*UnprocessedAccount) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*UnprocessedAccount) SetReason 

func (s *UnprocessedAccount) SetReason(v string) *UnprocessedAccount

SetReason sets the Reason field's value.

func (UnprocessedAccount) String 

func (s UnprocessedAccount) String() string

String returns the string representation

type ValidationException added in v1.28.0 

type ValidationException struct {
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request parameters are invalid.

func (ValidationException) Code added in v1.28.0 

func (s ValidationException) Code() string

Code returns the exception type name.

func (ValidationException) Error added in v1.28.0 

func (s ValidationException) Error() string

func (ValidationException) GoString added in v1.28.0 

func (s ValidationException) GoString() string

GoString returns the string representation

func (ValidationException) Message added in v1.28.0 

func (s ValidationException) Message() string

Message returns the exception's message.

func (ValidationException) OrigErr added in v1.28.0 

func (s ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ValidationException) RequestID added in v1.28.0 

func (s ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ValidationException) StatusCode added in v1.28.0 

func (s ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.28.0 

func (s ValidationException) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package detectiveiface provides an interface to enable mocking the Amazon Detective service client for testing your code.
 Package detectiveiface provides an interface to enable mocking the Amazon Detective 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.