types

package
v0.28.0 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2020 License: Apache-2.0 Imports: 3 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AffectedEntity 

type AffectedEntity struct {

	// The 12-digit AWS account number that contains the affected entity.
	AwsAccountId *string

	// The unique identifier for the entity. Format:
	// arn:aws:health:entity-region:aws-account:entity/entity-id . Example:
	// arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
	EntityArn *string

	// The URL of the affected entity.
	EntityUrl *string

	// The ID of the affected entity.
	EntityValue *string

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string

	// The most recent time that the entity was updated.
	LastUpdatedTime *time.Time

	// The most recent status of the entity affected by the event. The possible values
	// are IMPAIRED, UNIMPAIRED, and UNKNOWN.
	StatusCode EntityStatusCode

	// A map of entity tags attached to the affected entity.
	Tags map[string]*string
}

Information about an entity that is affected by a Health event.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string
}

EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

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

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type DateTimeRange 

type DateTimeRange struct {

	// The starting date and time of a time range.
	From *time.Time

	// The ending date and time of a time range.
	To *time.Time
}

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.

type EntityAggregate 

type EntityAggregate struct {

	// The number entities that match the criteria for the specified events.
	Count *int32

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string
}

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

type EntityFilter 

type EntityFilter struct {

	// A list of event ARNs (unique identifiers). For example:
	// "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
	// "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
	//
	// This member is required.
	EventArns []*string

	// A list of entity ARNs (unique identifiers).
	EntityArns []*string

	// A list of IDs for affected entities.
	EntityValues []*string

	// A list of the most recent dates and times that the entity was updated.
	LastUpdatedTimes []*DateTimeRange

	// A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
	StatusCodes []EntityStatusCode

	// A map of entity tags attached to the affected entity.
	Tags []map[string]*string
}

The values to use to filter results from the DescribeAffectedEntities operation.

type EntityStatusCode 

type EntityStatusCode string
const (
	EntityStatusCodeImpaired   EntityStatusCode = "IMPAIRED"
	EntityStatusCodeUnimpaired EntityStatusCode = "UNIMPAIRED"
	EntityStatusCodeUnknown    EntityStatusCode = "UNKNOWN"
)

Enum values for EntityStatusCode

type Event 

type Event struct {

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	Arn *string

	// The AWS Availability Zone of the event. For example, us-east-1a.
	AvailabilityZone *string

	// The date and time that the event ended.
	EndTime *time.Time

	EventScopeCode EventScopeCode

	// The category of the event. Possible values are issue, scheduledChange, and
	// accountNotification.
	EventTypeCategory EventTypeCategory

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION
	// ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
	EventTypeCode *string

	// The most recent date and time that the event was updated.
	LastUpdatedTime *time.Time

	// The AWS region name of the event.
	Region *string

	// The AWS service that is affected by the event. For example, EC2, RDS.
	Service *string

	// The date and time that the event began.
	StartTime *time.Time

	// The most recent status of the event. Possible values are open, closed, and
	// upcoming.
	StatusCode EventStatusCode
}

Summary information about an AWS Health event.

type EventAccountFilter 

type EventAccountFilter struct {

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	//
	// This member is required.
	EventArn *string

	// The 12-digit AWS account numbers that contains the affected entities.
	AwsAccountId *string
}

The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.

type EventAggregate 

type EventAggregate struct {

	// The issue type for the associated count.
	AggregateValue *string

	// The number of events of the associated issue type.
	Count *int32
}

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

type EventAggregateField 

type EventAggregateField string
const (
	EventAggregateFieldEventtypecategory EventAggregateField = "eventTypeCategory"
)

Enum values for EventAggregateField

type EventDescription 

type EventDescription struct {

	// The most recent description of the event.
	LatestDescription *string
}

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

type EventDetails 

type EventDetails struct {

	// Summary information about the event.
	Event *Event

	// The most recent description of the event.
	EventDescription *EventDescription

	// Additional metadata about the event.
	EventMetadata map[string]*string
}

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.

type EventDetailsErrorItem 

type EventDetailsErrorItem struct {

	// A message that describes the error.
	ErrorMessage *string

	// The name of the error.
	ErrorName *string

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string
}

Error information returned when a DescribeEventDetails operation cannot find a specified event.

type EventFilter 

type EventFilter struct {

	// A list of AWS availability zones.
	AvailabilityZones []*string

	// A list of dates and times that the event ended.
	EndTimes []*DateTimeRange

	// A list of entity ARNs (unique identifiers).
	EntityArns []*string

	// A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS
	// volumes (vol-426ab23e).
	EntityValues []*string

	// A list of event ARNs (unique identifiers). For example:
	// "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
	// "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
	EventArns []*string

	// A list of event status codes.
	EventStatusCodes []EventStatusCode

	// A list of event type category codes (issue, scheduledChange, or
	// accountNotification).
	EventTypeCategories []EventTypeCategory

	// A list of unique identifiers for event types. For example,
	// "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
	EventTypeCodes []*string

	// A list of dates and times that the event was last updated.
	LastUpdatedTimes []*DateTimeRange

	// A list of AWS regions.
	Regions []*string

	// The AWS services associated with the event. For example, EC2, RDS.
	Services []*string

	// A list of dates and times that the event began.
	StartTimes []*DateTimeRange

	// A map of entity tags attached to the affected entity.
	Tags []map[string]*string
}

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

type EventScopeCode 

type EventScopeCode string
const (
	EventScopeCodePublic           EventScopeCode = "PUBLIC"
	EventScopeCodeAccount_specific EventScopeCode = "ACCOUNT_SPECIFIC"
	EventScopeCodeNone             EventScopeCode = "NONE"
)

Enum values for EventScopeCode

type EventStatusCode 

type EventStatusCode string
const (
	EventStatusCodeOpen     EventStatusCode = "open"
	EventStatusCodeClosed   EventStatusCode = "closed"
	EventStatusCodeUpcoming EventStatusCode = "upcoming"
)

Enum values for EventStatusCode

type EventType 

type EventType struct {

	// A list of event type category codes (issue, scheduledChange, or
	// accountNotification).
	Category EventTypeCategory

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION
	// ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
	Code *string

	// The AWS service that is affected by the event. For example, EC2, RDS.
	Service *string
}

Metadata about a type of event that is reported by AWS Health. Data consists of the category (for example, issue), the service (for example, EC2), and the event type code (for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

type EventTypeCategory 

type EventTypeCategory string
const (
	EventTypeCategoryIssue                EventTypeCategory = "issue"
	EventTypeCategoryAccount_notification EventTypeCategory = "accountNotification"
	EventTypeCategoryScheduled_change     EventTypeCategory = "scheduledChange"
	EventTypeCategoryInvestigation        EventTypeCategory = "investigation"
)

Enum values for EventTypeCategory

type EventTypeFilter 

type EventTypeFilter struct {

	// A list of event type category codes (issue, scheduledChange, or
	// accountNotification).
	EventTypeCategories []EventTypeCategory

	// A list of event type codes.
	EventTypeCodes []*string

	// The AWS services associated with the event. For example, EC2, RDS.
	Services []*string
}

The values to use to filter results from the DescribeEventTypes operation.

type InvalidPaginationToken 

type InvalidPaginationToken struct {
	Message *string
}

The specified pagination token (nextToken) is not valid.

func (*InvalidPaginationToken) Error 

func (e *InvalidPaginationToken) Error() string

func (*InvalidPaginationToken) ErrorCode 

func (e *InvalidPaginationToken) ErrorCode() string

func (*InvalidPaginationToken) ErrorFault 

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

func (*InvalidPaginationToken) ErrorMessage 

func (e *InvalidPaginationToken) ErrorMessage() string

type OrganizationAffectedEntitiesErrorItem 

type OrganizationAffectedEntitiesErrorItem struct {

	// The 12-digit AWS account numbers that contains the affected entities.
	AwsAccountId *string

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION.
	// For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
	ErrorMessage *string

	// The name of the error.
	ErrorName *string

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string
}

Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a specific entity.

type OrganizationEvent 

type OrganizationEvent struct {

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	Arn *string

	// The date and time that the event ended.
	EndTime *time.Time

	EventScopeCode EventScopeCode

	// The category of the event type.
	EventTypeCategory EventTypeCategory

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION.
	// For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
	EventTypeCode *string

	// The most recent date and time that the event was updated.
	LastUpdatedTime *time.Time

	// The AWS Region name of the event.
	Region *string

	// The AWS service that is affected by the event. For example, EC2, RDS.
	Service *string

	// The date and time that the event began.
	StartTime *time.Time

	// The most recent status of the event. Possible values are open, closed, and
	// upcoming.
	StatusCode EventStatusCode
}

Summary information about an event, returned by the DescribeEventsForOrganization operation.

type OrganizationEventDetails 

type OrganizationEventDetails struct {

	// The 12-digit AWS account numbers that contains the affected entities.
	AwsAccountId *string

	// Summary information about an AWS Health event.
	Event *Event

	// The detailed description of the event. Included in the information returned by
	// the DescribeEventDetails operation.
	EventDescription *EventDescription

	// Additional metadata about the event.
	EventMetadata map[string]*string
}

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.

type OrganizationEventDetailsErrorItem 

type OrganizationEventDetailsErrorItem struct {

	// Error information returned when a DescribeEventDetailsForOrganization operation
	// cannot find a specified event.
	AwsAccountId *string

	// A message that describes the error.
	ErrorMessage *string

	// The name of the error.
	ErrorName *string

	// The unique identifier for the event. Format:
	// arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID .
	// Example: Example:
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	EventArn *string
}

Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.

type OrganizationEventFilter 

type OrganizationEventFilter struct {

	// A list of 12-digit AWS account numbers that contains the affected entities.
	AwsAccountIds []*string

	// A range of dates and times that is used by the EventFilter and EntityFilter
	// objects. If from is set and to is set: match items where the timestamp
	// (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If
	// from is set and to is not set: match items where the timestamp value is equal to
	// or after from. If from is not set and to is set: match items where the timestamp
	// value is equal to or before to.
	EndTime *DateTimeRange

	// REPLACEME
	EntityArns []*string

	// A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS
	// volumes (vol-426ab23e).
	EntityValues []*string

	// A list of event status codes.
	EventStatusCodes []EventStatusCode

	// REPLACEME
	EventTypeCategories []EventTypeCategory

	// A list of unique identifiers for event types. For example,
	// "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
	EventTypeCodes []*string

	// A range of dates and times that is used by the EventFilter and EntityFilter
	// objects. If from is set and to is set: match items where the timestamp
	// (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If
	// from is set and to is not set: match items where the timestamp value is equal to
	// or after from. If from is not set and to is set: match items where the timestamp
	// value is equal to or before to.
	LastUpdatedTime *DateTimeRange

	// A list of AWS Regions.
	Regions []*string

	// The AWS services associated with the event. For example, EC2, RDS.
	Services []*string

	// A range of dates and times that is used by the EventFilter and EntityFilter
	// objects. If from is set and to is set: match items where the timestamp
	// (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If
	// from is set and to is not set: match items where the timestamp value is equal to
	// or after from. If from is not set and to is set: match items where the timestamp
	// value is equal to or before to.
	StartTime *DateTimeRange
}

The values to filter results from the DescribeEventsForOrganization operation.

type UnsupportedLocale 

type UnsupportedLocale struct {
	Message *string
}

The specified locale is not supported.

func (*UnsupportedLocale) Error 

func (e *UnsupportedLocale) Error() string

func (*UnsupportedLocale) ErrorCode 

func (e *UnsupportedLocale) ErrorCode() string

func (*UnsupportedLocale) ErrorFault 

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

func (*UnsupportedLocale) ErrorMessage 

func (e *UnsupportedLocale) ErrorMessage() string

Source Files

View all Source files

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.