package types

import "github.com/aws/aws-sdk-go-v2/service/detective/types"

Index

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_         ErrorCode
	ErrorCodeReason    *string
	SubErrorCode       ErrorCode
	SubErrorCodeReason *string
	// contains filtered or unexported fields
}

The request issuer does not have permission to access this resource or perform this operation.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type Account

type Account struct {

	// The account identifier of the Amazon Web Services account.
	//
	// This member is required.
	AccountId *string

	// The Amazon Web Services account root user email address for the Amazon Web
	// Services account.
	//
	// This member is required.
	EmailAddress *string
	// contains filtered or unexported fields
}

An Amazon Web Services account that is the administrator account of or a member of a behavior graph.

type Administrator

type Administrator struct {

	// The Amazon Web Services account identifier of the Detective administrator
	// account for the organization.
	AccountId *string

	// The date and time when the Detective administrator account was enabled. The
	// value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
	DelegationTime *time.Time

	// The ARN of the organization behavior graph.
	GraphArn *string
	// contains filtered or unexported fields
}

Information about the Detective administrator account for an organization.

type ConflictException

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request attempted an invalid action.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type DatasourcePackage

type DatasourcePackage string
const (
	DatasourcePackageDetectiveCore DatasourcePackage = "DETECTIVE_CORE"
	DatasourcePackageEksAudit      DatasourcePackage = "EKS_AUDIT"
)

Enum values for DatasourcePackage

func (DatasourcePackage) Values

Values returns all known values for DatasourcePackage. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DatasourcePackageIngestDetail

type DatasourcePackageIngestDetail struct {

	// Details on which data source packages are ingested for a member account.
	DatasourcePackageIngestState DatasourcePackageIngestState

	// The date a data source package was enabled for this account
	LastIngestStateChange map[string]TimestampForCollection
	// contains filtered or unexported fields
}

Details about the data source packages ingested by your behavior graph.

type DatasourcePackageIngestState

type DatasourcePackageIngestState string
const (
	DatasourcePackageIngestStateStarted  DatasourcePackageIngestState = "STARTED"
	DatasourcePackageIngestStateStopped  DatasourcePackageIngestState = "STOPPED"
	DatasourcePackageIngestStateDisabled DatasourcePackageIngestState = "DISABLED"
)

Enum values for DatasourcePackageIngestState

func (DatasourcePackageIngestState) Values

Values returns all known values for DatasourcePackageIngestState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DatasourcePackageUsageInfo

type DatasourcePackageUsageInfo struct {

	// Total volume of data in bytes per day ingested for a given data source package.
	VolumeUsageInBytes *int64

	// The data and time when the member account data volume was last updated. The
	// value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
	VolumeUsageUpdateTime *time.Time
	// contains filtered or unexported fields
}

Information on the usage of a data source package in the behavior graph.

type ErrorCode

type ErrorCode string
const (
	ErrorCodeInvalidGraphArn    ErrorCode = "INVALID_GRAPH_ARN"
	ErrorCodeInvalidRequestBody ErrorCode = "INVALID_REQUEST_BODY"
	ErrorCodeInternalError      ErrorCode = "INTERNAL_ERROR"
)

Enum values for ErrorCode

func (ErrorCode) Values

func (ErrorCode) Values() []ErrorCode

Values returns all known values for ErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Graph

type Graph struct {

	// The ARN of the behavior graph.
	Arn *string

	// The date and time that the behavior graph was created. The value is an ISO8601
	// formatted string. For example, 2021-08-18T16:35:56.284Z.
	CreatedTime *time.Time
	// contains filtered or unexported fields
}

A behavior graph in Detective.

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type InvitationType

type InvitationType string
const (
	InvitationTypeInvitation   InvitationType = "INVITATION"
	InvitationTypeOrganization InvitationType = "ORGANIZATION"
)

Enum values for InvitationType

func (InvitationType) Values

func (InvitationType) Values() []InvitationType

Values returns all known values for InvitationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MemberDetail

type MemberDetail struct {

	// The Amazon Web Services account identifier for the member account.
	AccountId *string

	// The Amazon Web Services account identifier of the administrator account for the
	// behavior graph.
	AdministratorId *string

	// The state of a data source package for the behavior graph.
	DatasourcePackageIngestStates map[string]DatasourcePackageIngestState

	// For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the
	// member account is not enabled. The reason can have one of the following
	// values:
	//
	// * VOLUME_TOO_HIGH - Indicates that adding the member account would
	// cause the data volume for the behavior graph to be too high.
	//
	// * VOLUME_UNKNOWN -
	// Indicates that Detective is unable to verify the data volume for the member
	// account. This is usually because the member account is not enrolled in Amazon
	// GuardDuty.
	DisabledReason MemberDisabledReason

	// The Amazon Web Services account root user email address for the member account.
	EmailAddress *string

	// The ARN of the behavior graph.
	GraphArn *string

	// The type of behavior graph membership. For an organization account in the
	// organization behavior graph, the type is ORGANIZATION. For an account that was
	// invited to a behavior graph, the type is INVITATION.
	InvitationType InvitationType

	// For invited accounts, the date and time that Detective sent the invitation to
	// the account. The value is an ISO8601 formatted string. For example,
	// 2021-08-18T16:35:56.284Z.
	InvitedTime *time.Time

	// The Amazon Web Services account identifier of the administrator account for the
	// behavior graph.
	//
	// Deprecated: This property is deprecated. Use AdministratorId instead.
	MasterId *string

	// The member account data volume as a percentage of the maximum allowed data
	// volume. 0 indicates 0 percent, and 100 indicates 100 percent. Note that this is
	// not the percentage of the behavior graph data volume. For example, the data
	// volume for the behavior graph is 80 GB per day. The maximum data volume is 160
	// GB per day. If the data volume for the member account is 40 GB per day, then
	// PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data
	// volume.
	//
	// Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage
	// instead.
	PercentOfGraphUtilization *float64

	// The date and time when the graph utilization percentage was last updated. The
	// value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
	//
	// Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage
	// instead.
	PercentOfGraphUtilizationUpdatedTime *time.Time

	// The current membership status of the member account. The status can have one of
	// the following values:
	//
	// * INVITED - For invited accounts only. Indicates that the
	// member was sent an invitation but has not yet responded.
	//
	// *
	// VERIFICATION_IN_PROGRESS - For invited accounts only, 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. For organization accounts in the organization
	// behavior graph, indicates that Detective is verifying that the account belongs
	// to the organization.
	//
	// * VERIFICATION_FAILED - For invited accounts only.
	// 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 currently contributes data to the behavior
	// graph. For invited accounts, the member account accepted the invitation. For
	// organization accounts in the organization behavior graph, the Detective
	// administrator account enabled the organization account as a member account.
	//
	// *
	// ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by
	// the Detective administrator account, but is prevented from contributing data to
	// the behavior graph. DisabledReason provides the reason why the member account is
	// not enabled.
	//
	// Invited accounts that declined an invitation or that were removed
	// from the behavior graph are not included. In the organization behavior graph,
	// organization accounts that the Detective administrator account did not enable
	// are not included.
	Status MemberStatus

	// The date and time that the member account was last updated. The value is an
	// ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
	UpdatedTime *time.Time

	// Details on the volume of usage for each data source package in a behavior graph.
	VolumeUsageByDatasourcePackage map[string]DatasourcePackageUsageInfo

	// The data volume in bytes per day for the member account.
	//
	// Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage
	// instead.
	VolumeUsageInBytes *int64

	// The data and time when the member account data volume was last updated. The
	// value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
	//
	// Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage
	// instead.
	VolumeUsageUpdatedTime *time.Time
	// contains filtered or unexported fields
}

Details about a member account in a behavior graph.

type MemberDisabledReason

type MemberDisabledReason string
const (
	MemberDisabledReasonVolumeTooHigh MemberDisabledReason = "VOLUME_TOO_HIGH"
	MemberDisabledReasonVolumeUnknown MemberDisabledReason = "VOLUME_UNKNOWN"
)

Enum values for MemberDisabledReason

func (MemberDisabledReason) Values

Values returns all known values for MemberDisabledReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MemberStatus

type MemberStatus string
const (
	MemberStatusInvited                MemberStatus = "INVITED"
	MemberStatusVerificationInProgress MemberStatus = "VERIFICATION_IN_PROGRESS"
	MemberStatusVerificationFailed     MemberStatus = "VERIFICATION_FAILED"
	MemberStatusEnabled                MemberStatus = "ENABLED"
	MemberStatusAcceptedButDisabled    MemberStatus = "ACCEPTED_BUT_DISABLED"
)

Enum values for MemberStatus

func (MemberStatus) Values

func (MemberStatus) Values() []MemberStatus

Values returns all known values for MemberStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MembershipDatasources

type MembershipDatasources struct {

	// The account identifier of the Amazon Web Services account.
	AccountId *string

	// Details on when a data source package was added to a behavior graph.
	DatasourcePackageIngestHistory map[string]map[string]TimestampForCollection

	// The ARN of the organization behavior graph.
	GraphArn *string
	// contains filtered or unexported fields
}

Details on data source packages for members of the behavior graph.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request refers to a nonexistent resource.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Resources []string
	// contains filtered or unexported fields
}

This request cannot be completed for one of the following reasons.

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

* The request would cause the data rate for the behavior graph to exceed the maximum allowed.

* Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type TimestampForCollection

type TimestampForCollection struct {

	// The data and time when data collection began for a source package. The value is
	// an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
	Timestamp *time.Time
	// contains filtered or unexported fields
}

Details on when data collection began for a source package.

type TooManyRequestsException

type TooManyRequestsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request cannot be completed because too many other requests are occurring at the same time.

func (*TooManyRequestsException) Error

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage

func (e *TooManyRequestsException) ErrorMessage() string

type UnprocessedAccount

type UnprocessedAccount struct {

	// The Amazon Web Services account identifier of the member account that was not
	// processed.
	AccountId *string

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

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

type UnprocessedGraph

type UnprocessedGraph struct {

	// The ARN of the organization behavior graph.
	GraphArn *string

	// The reason data source package information could not be processed for a behavior
	// graph.
	Reason *string
	// contains filtered or unexported fields
}

Behavior graphs that could not be processed in the request.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_      ErrorCode
	ErrorCodeReason *string
	// contains filtered or unexported fields
}

The request parameters are invalid.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

Source Files

enums.go errors.go types.go

Version
v1.18.3
Published
Feb 20, 2023
Platform
js/wasm
Imports
4 packages
Last checked
1 day ago

Tools for package owners.