Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {

	// The account identifier of the AWS account.
	//
	// This member is required.
	AccountId *string

	// The AWS account root user email address for the AWS account.
	//
	// This member is required.
	EmailAddress *string
}

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

    type ConflictException

    type ConflictException struct {
    	Message *string
    }

      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 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 in
      	// milliseconds since the epoch.
      	CreatedTime *time.Time
      }

        A behavior graph in Detective.

        type InternalServerException

        type InternalServerException struct {
        	Message *string
        }

          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 MemberDetail

          type MemberDetail struct {
          
          	// The AWS account identifier for the member account.
          	AccountId *string
          
          	// 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 AWS account root user email address for the member account.
          	EmailAddress *string
          
          	// The ARN of the behavior graph that the member account was invited to.
          	GraphArn *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
          
          	// The AWS account identifier of the master account for the behavior graph.
          	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.
          	PercentOfGraphUtilization *float64
          
          	// The date and time when the graph utilization percentage was last updated.
          	PercentOfGraphUtilizationUpdatedTime *time.Time
          
          	// 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.
          	//
          	// * ACCEPTED_BUT_DISABLED - Indicates that the member account
          	// accepted the invitation but is prevented from contributing data to the behavior
          	// graph. DisabledReason provides the reason why the member account is not
          	// enabled.
          	//
          	// Member accounts that declined an invitation or that were removed from
          	// the behavior graph are not included.
          	Status MemberStatus
          
          	// The date and time that the member account was last updated. The value is in
          	// milliseconds since the epoch.
          	UpdatedTime *time.Time
          }

            Details about a member account that was invited to contribute to 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 ResourceNotFoundException

                    type ResourceNotFoundException struct {
                    	Message *string
                    }

                      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
                      }

                        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 1000 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 UnprocessedAccount

                        type UnprocessedAccount struct {
                        
                        	// The AWS 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
                        }

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

                          type ValidationException

                          type ValidationException struct {
                          	Message *string
                          }

                            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