health

package
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: May 26, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package health provides the client and types for making API requests to AWS Health APIs and Notifications.

The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard (https://phd.aws.amazon.com/phd/home#/). You can get information about events that affect your AWS resources:

  • DescribeEvents: Summary information about events.

  • DescribeEventDetails: Detailed information about one or more events.

  • DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.

In addition, these operations provide information about event types and summary counts of events or affected entities:

  • DescribeEventTypes: Information about the kinds of events that AWS Health tracks.

  • DescribeEventAggregates: A count of the number of events that meet specified criteria.

  • DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.

The Health API requires a Business or Enterprise support plan from AWS Support (http://aws.amazon.com/premiumsupport/). Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

For authentication of requests, AWS Health uses the Signature Version 4 Signing Process (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

See the AWS Health User Guide (http://docs.aws.amazon.com/health/latest/ug/what-is-aws-health.html) for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

See https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04 for more information on this service.

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

Using the Client

To AWS Health APIs and Notifications 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 AWS Health APIs and Notifications client Health for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/health/#New

Index

Constants

View Source
const (

	// ErrCodeInvalidPaginationToken for service response error code
	// "InvalidPaginationToken".
	//
	// The specified pagination token (nextToken) is not valid.
	ErrCodeInvalidPaginationToken = "InvalidPaginationToken"

	// ErrCodeUnsupportedLocale for service response error code
	// "UnsupportedLocale".
	//
	// The specified locale is not supported.
	ErrCodeUnsupportedLocale = "UnsupportedLocale"
)
View Source
const (
	ServiceName = "health"    // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

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 `locationName:"awsAccountId" type:"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 `locationName:"entityArn" type:"string"`

	// The ID of the affected entity.
	EntityValue *string `locationName:"entityValue" type:"string"`

	// The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID.
	// Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
	EventArn *string `locationName:"eventArn" type:"string"`

	// The most recent time that the entity was updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp" timestampFormat:"unix"`

	// The most recent status of the entity affected by the event. The possible
	// values are IMPAIRED, UNIMPAIRED, and UNKNOWN.
	StatusCode EntityStatusCode `locationName:"statusCode" type:"string" enum:"true"`

	// A map of entity tags attached to the affected entity.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Information about an entity that is affected by a Health event. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/AffectedEntity

func (AffectedEntity) GoString

func (s AffectedEntity) GoString() string

GoString returns the string representation

func (AffectedEntity) String

func (s AffectedEntity) String() string

String returns the string representation

type DateTimeRange

type DateTimeRange struct {

	// The starting date and time of a time range.
	From *time.Time `locationName:"from" type:"timestamp" timestampFormat:"unix"`

	// The ending date and time of a time range.
	To *time.Time `locationName:"to" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DateTimeRange

func (DateTimeRange) GoString

func (s DateTimeRange) GoString() string

GoString returns the string representation

func (DateTimeRange) String

func (s DateTimeRange) String() string

String returns the string representation

type DescribeAffectedEntitiesInput

type DescribeAffectedEntitiesInput struct {

	// Values to narrow the results returned. At least one event ARN is required.
	//
	// Filter is a required field
	Filter *EntityFilter `locationName:"filter" type:"structure" required:"true"`

	// The locale (language) to return information in. English (en) is the default
	// and the only supported value at this time.
	Locale *string `locationName:"locale" min:"2" type:"string"`

	// The maximum number of items to return in one batch, between 10 and 100, inclusive.
	MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesRequest

func (DescribeAffectedEntitiesInput) GoString

GoString returns the string representation

func (DescribeAffectedEntitiesInput) String

String returns the string representation

func (*DescribeAffectedEntitiesInput) Validate

func (s *DescribeAffectedEntitiesInput) Validate() error

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

type DescribeAffectedEntitiesOutput

type DescribeAffectedEntitiesOutput struct {

	// The entities that match the filter criteria.
	Entities []AffectedEntity `locationName:"entities" type:"list"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesResponse

func (DescribeAffectedEntitiesOutput) GoString

GoString returns the string representation

func (DescribeAffectedEntitiesOutput) SDKResponseMetadata

func (s DescribeAffectedEntitiesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeAffectedEntitiesOutput) String

String returns the string representation

type DescribeAffectedEntitiesPager added in v0.3.0

type DescribeAffectedEntitiesPager struct {
	aws.Pager
}

DescribeAffectedEntitiesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeAffectedEntitiesPager) CurrentPage added in v0.3.0

type DescribeAffectedEntitiesRequest

type DescribeAffectedEntitiesRequest struct {
	*aws.Request
	Input *DescribeAffectedEntitiesInput
	Copy  func(*DescribeAffectedEntitiesInput) DescribeAffectedEntitiesRequest
}

DescribeAffectedEntitiesRequest is a API request type for the DescribeAffectedEntities API operation.

func (*DescribeAffectedEntitiesRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a DescribeAffectedEntitiesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeAffectedEntities operation.
		req := client.DescribeAffectedEntitiesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeAffectedEntitiesRequest) Send

Send marshals and sends the DescribeAffectedEntities API request.

type DescribeEntityAggregatesInput

type DescribeEntityAggregatesInput struct {

	// A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
	// "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"
	EventArns []string `locationName:"eventArns" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEntityAggregatesRequest

func (DescribeEntityAggregatesInput) GoString

GoString returns the string representation

func (DescribeEntityAggregatesInput) String

String returns the string representation

func (*DescribeEntityAggregatesInput) Validate

func (s *DescribeEntityAggregatesInput) Validate() error

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

type DescribeEntityAggregatesOutput

type DescribeEntityAggregatesOutput struct {

	// The number of entities that are affected by each of the specified events.
	EntityAggregates []EntityAggregate `locationName:"entityAggregates" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEntityAggregatesResponse

func (DescribeEntityAggregatesOutput) GoString

GoString returns the string representation

func (DescribeEntityAggregatesOutput) SDKResponseMetadata

func (s DescribeEntityAggregatesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeEntityAggregatesOutput) String

String returns the string representation

type DescribeEntityAggregatesRequest

type DescribeEntityAggregatesRequest struct {
	*aws.Request
	Input *DescribeEntityAggregatesInput
	Copy  func(*DescribeEntityAggregatesInput) DescribeEntityAggregatesRequest
}

DescribeEntityAggregatesRequest is a API request type for the DescribeEntityAggregates API operation.

func (DescribeEntityAggregatesRequest) Send

Send marshals and sends the DescribeEntityAggregates API request.

type DescribeEventAggregatesInput

type DescribeEventAggregatesInput struct {

	// The only currently supported value is eventTypeCategory.
	//
	// AggregateField is a required field
	AggregateField EventAggregateField `locationName:"aggregateField" type:"string" required:"true" enum:"true"`

	// Values to narrow the results returned.
	Filter *EventFilter `locationName:"filter" type:"structure"`

	// The maximum number of items to return in one batch, between 10 and 100, inclusive.
	MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventAggregatesRequest

func (DescribeEventAggregatesInput) GoString

func (s DescribeEventAggregatesInput) GoString() string

GoString returns the string representation

func (DescribeEventAggregatesInput) String

String returns the string representation

func (*DescribeEventAggregatesInput) Validate

func (s *DescribeEventAggregatesInput) Validate() error

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

type DescribeEventAggregatesOutput

type DescribeEventAggregatesOutput struct {

	// The number of events in each category that meet the optional filter criteria.
	EventAggregates []EventAggregate `locationName:"eventAggregates" type:"list"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventAggregatesResponse

func (DescribeEventAggregatesOutput) GoString

GoString returns the string representation

func (DescribeEventAggregatesOutput) SDKResponseMetadata

func (s DescribeEventAggregatesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeEventAggregatesOutput) String

String returns the string representation

type DescribeEventAggregatesPager added in v0.3.0

type DescribeEventAggregatesPager struct {
	aws.Pager
}

DescribeEventAggregatesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeEventAggregatesPager) CurrentPage added in v0.3.0

type DescribeEventAggregatesRequest

type DescribeEventAggregatesRequest struct {
	*aws.Request
	Input *DescribeEventAggregatesInput
	Copy  func(*DescribeEventAggregatesInput) DescribeEventAggregatesRequest
}

DescribeEventAggregatesRequest is a API request type for the DescribeEventAggregates API operation.

func (*DescribeEventAggregatesRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a DescribeEventAggregatesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeEventAggregates operation.
		req := client.DescribeEventAggregatesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeEventAggregatesRequest) Send

Send marshals and sends the DescribeEventAggregates API request.

type DescribeEventDetailsInput

type DescribeEventDetailsInput struct {

	// A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
	// "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"
	//
	// EventArns is a required field
	EventArns []string `locationName:"eventArns" min:"1" type:"list" required:"true"`

	// The locale (language) to return information in. English (en) is the default
	// and the only supported value at this time.
	Locale *string `locationName:"locale" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsRequest

func (DescribeEventDetailsInput) GoString

func (s DescribeEventDetailsInput) GoString() string

GoString returns the string representation

func (DescribeEventDetailsInput) String

func (s DescribeEventDetailsInput) String() string

String returns the string representation

func (*DescribeEventDetailsInput) Validate

func (s *DescribeEventDetailsInput) Validate() error

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

type DescribeEventDetailsOutput

type DescribeEventDetailsOutput struct {

	// Error messages for any events that could not be retrieved.
	FailedSet []EventDetailsErrorItem `locationName:"failedSet" type:"list"`

	// Information about the events that could be retrieved.
	SuccessfulSet []EventDetails `locationName:"successfulSet" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsResponse

func (DescribeEventDetailsOutput) GoString

func (s DescribeEventDetailsOutput) GoString() string

GoString returns the string representation

func (DescribeEventDetailsOutput) SDKResponseMetadata

func (s DescribeEventDetailsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeEventDetailsOutput) String

String returns the string representation

type DescribeEventDetailsRequest

type DescribeEventDetailsRequest struct {
	*aws.Request
	Input *DescribeEventDetailsInput
	Copy  func(*DescribeEventDetailsInput) DescribeEventDetailsRequest
}

DescribeEventDetailsRequest is a API request type for the DescribeEventDetails API operation.

func (DescribeEventDetailsRequest) Send

Send marshals and sends the DescribeEventDetails API request.

type DescribeEventTypesInput

type DescribeEventTypesInput struct {

	// Values to narrow the results returned.
	Filter *EventTypeFilter `locationName:"filter" type:"structure"`

	// The locale (language) to return information in. English (en) is the default
	// and the only supported value at this time.
	Locale *string `locationName:"locale" min:"2" type:"string"`

	// The maximum number of items to return in one batch, between 10 and 100, inclusive.
	MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventTypesRequest

func (DescribeEventTypesInput) GoString

func (s DescribeEventTypesInput) GoString() string

GoString returns the string representation

func (DescribeEventTypesInput) String

func (s DescribeEventTypesInput) String() string

String returns the string representation

func (*DescribeEventTypesInput) Validate

func (s *DescribeEventTypesInput) Validate() error

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

type DescribeEventTypesOutput

type DescribeEventTypesOutput struct {

	// A list of event types that match the filter criteria. Event types have a
	// category (issue, accountNotification, or scheduledChange), a service (for
	// example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION;
	// for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
	EventTypes []EventType `locationName:"eventTypes" type:"list"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventTypesResponse

func (DescribeEventTypesOutput) GoString

func (s DescribeEventTypesOutput) GoString() string

GoString returns the string representation

func (DescribeEventTypesOutput) SDKResponseMetadata

func (s DescribeEventTypesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeEventTypesOutput) String

func (s DescribeEventTypesOutput) String() string

String returns the string representation

type DescribeEventTypesPager added in v0.3.0

type DescribeEventTypesPager struct {
	aws.Pager
}

DescribeEventTypesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeEventTypesPager) CurrentPage added in v0.3.0

type DescribeEventTypesRequest

type DescribeEventTypesRequest struct {
	*aws.Request
	Input *DescribeEventTypesInput
	Copy  func(*DescribeEventTypesInput) DescribeEventTypesRequest
}

DescribeEventTypesRequest is a API request type for the DescribeEventTypes API operation.

func (*DescribeEventTypesRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a DescribeEventTypesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeEventTypes operation.
		req := client.DescribeEventTypesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeEventTypesRequest) Send

Send marshals and sends the DescribeEventTypes API request.

type DescribeEventsInput

type DescribeEventsInput struct {

	// Values to narrow the results returned.
	Filter *EventFilter `locationName:"filter" type:"structure"`

	// The locale (language) to return information in. English (en) is the default
	// and the only supported value at this time.
	Locale *string `locationName:"locale" min:"2" type:"string"`

	// The maximum number of items to return in one batch, between 10 and 100, inclusive.
	MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsRequest

func (DescribeEventsInput) GoString

func (s DescribeEventsInput) GoString() string

GoString returns the string representation

func (DescribeEventsInput) String

func (s DescribeEventsInput) String() string

String returns the string representation

func (*DescribeEventsInput) Validate

func (s *DescribeEventsInput) Validate() error

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

type DescribeEventsOutput

type DescribeEventsOutput struct {

	// The events that match the specified filter criteria.
	Events []Event `locationName:"events" type:"list"`

	// If the results of a search are large, only a portion of the results are returned,
	// and a nextToken pagination token is returned in the response. To retrieve
	// the next batch of results, reissue the search request and include the returned
	// token. When all results have been returned, the response does not contain
	// a pagination token value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsResponse

func (DescribeEventsOutput) GoString

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation

func (DescribeEventsOutput) SDKResponseMetadata

func (s DescribeEventsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeEventsOutput) String

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeEventsPager added in v0.3.0

type DescribeEventsPager struct {
	aws.Pager
}

DescribeEventsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeEventsPager) CurrentPage added in v0.3.0

func (p *DescribeEventsPager) CurrentPage() *DescribeEventsOutput

type DescribeEventsRequest

type DescribeEventsRequest struct {
	*aws.Request
	Input *DescribeEventsInput
	Copy  func(*DescribeEventsInput) DescribeEventsRequest
}

DescribeEventsRequest is a API request type for the DescribeEvents API operation.

func (*DescribeEventsRequest) Paginate added in v0.3.0

func (p *DescribeEventsRequest) Paginate(opts ...aws.Option) DescribeEventsPager

Paginate pages iterates over the pages of a DescribeEventsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeEvents operation.
		req := client.DescribeEventsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeEventsRequest) Send

Send marshals and sends the DescribeEvents API request.

type EntityAggregate

type EntityAggregate struct {

	// The number entities that match the criteria for the specified events.
	Count *int64 `locationName:"count" type:"integer"`

	// The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID.
	// Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
	EventArn *string `locationName:"eventArn" type:"string"`
	// contains filtered or unexported fields
}

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EntityAggregate

func (EntityAggregate) GoString

func (s EntityAggregate) GoString() string

GoString returns the string representation

func (EntityAggregate) String

func (s EntityAggregate) String() string

String returns the string representation

type EntityFilter

type EntityFilter struct {

	// A list of entity ARNs (unique identifiers).
	EntityArns []string `locationName:"entityArns" min:"1" type:"list"`

	// A list of IDs for affected entities.
	EntityValues []string `locationName:"entityValues" min:"1" type:"list"`

	// A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
	// "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"
	//
	// EventArns is a required field
	EventArns []string `locationName:"eventArns" min:"1" type:"list" required:"true"`

	// A list of the most recent dates and times that the entity was updated.
	LastUpdatedTimes []DateTimeRange `locationName:"lastUpdatedTimes" min:"1" type:"list"`

	// A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
	StatusCodes []EntityStatusCode `locationName:"statusCodes" min:"1" type:"list"`

	// A map of entity tags attached to the affected entity.
	Tags []map[string]string `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

The values to use to filter results from the DescribeAffectedEntities operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EntityFilter

func (EntityFilter) GoString

func (s EntityFilter) GoString() string

GoString returns the string representation

func (EntityFilter) String

func (s EntityFilter) String() string

String returns the string representation

func (*EntityFilter) Validate

func (s *EntityFilter) Validate() error

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

type EntityStatusCode

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

Enum values for EntityStatusCode

func (EntityStatusCode) MarshalValue added in v0.3.0

func (enum EntityStatusCode) MarshalValue() (string, error)

func (EntityStatusCode) MarshalValueBuf added in v0.3.0

func (enum EntityStatusCode) MarshalValueBuf(b []byte) ([]byte, error)

type Event

type Event struct {

	// The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID.
	// Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
	Arn *string `locationName:"arn" type:"string"`

	// The AWS Availability Zone of the event. For example, us-east-1a.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The date and time that the event ended.
	EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"unix"`

	// The
	EventTypeCategory EventTypeCategory `locationName:"eventTypeCategory" min:"3" type:"string" enum:"true"`

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION;
	// for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
	EventTypeCode *string `locationName:"eventTypeCode" min:"3" type:"string"`

	// The most recent date and time that the event was updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp" timestampFormat:"unix"`

	// The AWS region name of the event.
	Region *string `locationName:"region" type:"string"`

	// The AWS service that is affected by the event. For example, EC2, RDS.
	Service *string `locationName:"service" min:"2" type:"string"`

	// The date and time that the event began.
	StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"unix"`

	// The most recent status of the event. Possible values are open, closed, and
	// upcoming.
	StatusCode EventStatusCode `locationName:"statusCode" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/Event

func (Event) GoString

func (s Event) GoString() string

GoString returns the string representation

func (Event) String

func (s Event) String() string

String returns the string representation

type EventAggregate

type EventAggregate struct {

	// The issue type for the associated count.
	AggregateValue *string `locationName:"aggregateValue" type:"string"`

	// The number of events of the associated issue type.
	Count *int64 `locationName:"count" type:"integer"`
	// contains filtered or unexported fields
}

The number of events of each issue type. Returned by the DescribeEventAggregates operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventAggregate

func (EventAggregate) GoString

func (s EventAggregate) GoString() string

GoString returns the string representation

func (EventAggregate) String

func (s EventAggregate) String() string

String returns the string representation

type EventAggregateField

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

Enum values for EventAggregateField

func (EventAggregateField) MarshalValue added in v0.3.0

func (enum EventAggregateField) MarshalValue() (string, error)

func (EventAggregateField) MarshalValueBuf added in v0.3.0

func (enum EventAggregateField) MarshalValueBuf(b []byte) ([]byte, error)

type EventDescription

type EventDescription struct {

	// The most recent description of the event.
	LatestDescription *string `locationName:"latestDescription" type:"string"`
	// contains filtered or unexported fields
}

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventDescription

func (EventDescription) GoString

func (s EventDescription) GoString() string

GoString returns the string representation

func (EventDescription) String

func (s EventDescription) String() string

String returns the string representation

type EventDetails

type EventDetails struct {

	// Summary information about the event.
	Event *Event `locationName:"event" type:"structure"`

	// The most recent description of the event.
	EventDescription *EventDescription `locationName:"eventDescription" type:"structure"`

	// Additional metadata about the event.
	EventMetadata map[string]string `locationName:"eventMetadata" type:"map"`
	// contains filtered or unexported fields
}

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventDetails

func (EventDetails) GoString

func (s EventDetails) GoString() string

GoString returns the string representation

func (EventDetails) String

func (s EventDetails) String() string

String returns the string representation

type EventDetailsErrorItem

type EventDetailsErrorItem struct {

	// A message that describes the error.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The name of the error.
	ErrorName *string `locationName:"errorName" type:"string"`

	// The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID.
	// Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331
	EventArn *string `locationName:"eventArn" type:"string"`
	// contains filtered or unexported fields
}

Error information returned when a DescribeEventDetails operation cannot find a specified event. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventDetailsErrorItem

func (EventDetailsErrorItem) GoString

func (s EventDetailsErrorItem) GoString() string

GoString returns the string representation

func (EventDetailsErrorItem) String

func (s EventDetailsErrorItem) String() string

String returns the string representation

type EventFilter

type EventFilter struct {

	// A list of AWS availability zones.
	AvailabilityZones []string `locationName:"availabilityZones" type:"list"`

	// A list of dates and times that the event ended.
	EndTimes []DateTimeRange `locationName:"endTimes" min:"1" type:"list"`

	// A list of entity ARNs (unique identifiers).
	EntityArns []string `locationName:"entityArns" min:"1" type:"list"`

	// A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS
	// volumes (vol-426ab23e).
	EntityValues []string `locationName:"entityValues" min:"1" type:"list"`

	// A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331",
	// "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"
	EventArns []string `locationName:"eventArns" min:"1" type:"list"`

	// A list of event status codes.
	EventStatusCodes []EventStatusCode `locationName:"eventStatusCodes" min:"1" type:"list"`

	// A list of event type category codes (issue, scheduledChange, or accountNotification).
	EventTypeCategories []EventTypeCategory `locationName:"eventTypeCategories" min:"1" type:"list"`

	// A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"
	EventTypeCodes []string `locationName:"eventTypeCodes" min:"1" type:"list"`

	// A list of dates and times that the event was last updated.
	LastUpdatedTimes []DateTimeRange `locationName:"lastUpdatedTimes" min:"1" type:"list"`

	// A list of AWS regions.
	Regions []string `locationName:"regions" min:"1" type:"list"`

	// The AWS services associated with the event. For example, EC2, RDS.
	Services []string `locationName:"services" min:"1" type:"list"`

	// A list of dates and times that the event began.
	StartTimes []DateTimeRange `locationName:"startTimes" min:"1" type:"list"`

	// A map of entity tags attached to the affected entity.
	Tags []map[string]string `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventFilter

func (EventFilter) GoString

func (s EventFilter) GoString() string

GoString returns the string representation

func (EventFilter) String

func (s EventFilter) String() string

String returns the string representation

func (*EventFilter) Validate

func (s *EventFilter) Validate() error

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

type EventStatusCode

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

Enum values for EventStatusCode

func (EventStatusCode) MarshalValue added in v0.3.0

func (enum EventStatusCode) MarshalValue() (string, error)

func (EventStatusCode) MarshalValueBuf added in v0.3.0

func (enum EventStatusCode) MarshalValueBuf(b []byte) ([]byte, error)

type EventType

type EventType struct {

	// A list of event type category codes (issue, scheduledChange, or accountNotification).
	Category EventTypeCategory `locationName:"category" min:"3" type:"string" enum:"true"`

	// The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION;
	// for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
	Code *string `locationName:"code" min:"3" type:"string"`

	// The AWS service that is affected by the event. For example, EC2, RDS.
	Service *string `locationName:"service" min:"2" type:"string"`
	// contains filtered or unexported fields
}

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). Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventType

func (EventType) GoString

func (s EventType) GoString() string

GoString returns the string representation

func (EventType) String

func (s EventType) String() string

String returns the string representation

type EventTypeCategory

type EventTypeCategory string
const (
	EventTypeCategoryIssue               EventTypeCategory = "issue"
	EventTypeCategoryAccountNotification EventTypeCategory = "accountNotification"
	EventTypeCategoryScheduledChange     EventTypeCategory = "scheduledChange"
)

Enum values for EventTypeCategory

func (EventTypeCategory) MarshalValue added in v0.3.0

func (enum EventTypeCategory) MarshalValue() (string, error)

func (EventTypeCategory) MarshalValueBuf added in v0.3.0

func (enum EventTypeCategory) MarshalValueBuf(b []byte) ([]byte, error)

type EventTypeFilter

type EventTypeFilter struct {

	// A list of event type category codes (issue, scheduledChange, or accountNotification).
	EventTypeCategories []EventTypeCategory `locationName:"eventTypeCategories" min:"1" type:"list"`

	// A list of event type codes.
	EventTypeCodes []string `locationName:"eventTypeCodes" min:"1" type:"list"`

	// The AWS services associated with the event. For example, EC2, RDS.
	Services []string `locationName:"services" min:"1" type:"list"`
	// contains filtered or unexported fields
}

The values to use to filter results from the DescribeEventTypes operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventTypeFilter

func (EventTypeFilter) GoString

func (s EventTypeFilter) GoString() string

GoString returns the string representation

func (EventTypeFilter) String

func (s EventTypeFilter) String() string

String returns the string representation

func (*EventTypeFilter) Validate

func (s *EventTypeFilter) Validate() error

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

type Health

type Health struct {
	*aws.Client
}

Health provides the API operation methods for making requests to AWS Health APIs and Notifications. See this package's package overview docs for details on the service.

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

func New

func New(config aws.Config) *Health

New creates a new instance of the Health client with a config.

Example:

// Create a Health client from just a config.
svc := health.New(myConfig)

func (*Health) DescribeAffectedEntitiesRequest

func (c *Health) DescribeAffectedEntitiesRequest(input *DescribeAffectedEntitiesInput) DescribeAffectedEntitiesRequest

DescribeAffectedEntitiesRequest returns a request value for making API operation for AWS Health APIs and Notifications.

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

// Example sending a request using the DescribeAffectedEntitiesRequest method.
req := client.DescribeAffectedEntitiesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntities

func (*Health) DescribeEntityAggregatesRequest

func (c *Health) DescribeEntityAggregatesRequest(input *DescribeEntityAggregatesInput) DescribeEntityAggregatesRequest

DescribeEntityAggregatesRequest returns a request value for making API operation for AWS Health APIs and Notifications.

Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.

// Example sending a request using the DescribeEntityAggregatesRequest method.
req := client.DescribeEntityAggregatesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEntityAggregates

func (*Health) DescribeEventAggregatesRequest

func (c *Health) DescribeEventAggregatesRequest(input *DescribeEventAggregatesInput) DescribeEventAggregatesRequest

DescribeEventAggregatesRequest returns a request value for making API operation for AWS Health APIs and Notifications.

Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.

// Example sending a request using the DescribeEventAggregatesRequest method.
req := client.DescribeEventAggregatesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventAggregates

func (*Health) DescribeEventDetailsRequest

func (c *Health) DescribeEventDetailsRequest(input *DescribeEventDetailsInput) DescribeEventDetailsRequest

DescribeEventDetailsRequest returns a request value for making API operation for AWS Health APIs and Notifications.

Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation.

If a specified event cannot be retrieved, an error message is returned for that event.

// Example sending a request using the DescribeEventDetailsRequest method.
req := client.DescribeEventDetailsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetails

func (*Health) DescribeEventTypesRequest

func (c *Health) DescribeEventTypesRequest(input *DescribeEventTypesInput) DescribeEventTypesRequest

DescribeEventTypesRequest returns a request value for making API operation for AWS Health APIs and Notifications.

Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.

// Example sending a request using the DescribeEventTypesRequest method.
req := client.DescribeEventTypesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventTypes

func (*Health) DescribeEventsRequest

func (c *Health) DescribeEventsRequest(input *DescribeEventsInput) DescribeEventsRequest

DescribeEventsRequest returns a request value for making API operation for AWS Health APIs and Notifications.

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent.

// Example sending a request using the DescribeEventsRequest method.
req := client.DescribeEventsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEvents

Directories

Path Synopsis
Package healthiface provides an interface to enable mocking the AWS Health APIs and Notifications service client for testing your code.
Package healthiface provides an interface to enable mocking the AWS Health APIs and Notifications service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL