health

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2019 License: Apache-2.0 Imports: 6 Imported by: 26

Documentation

Overview

Package health provides the client and types for making API requests to AWSHealth.

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 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

See the AWS Health User Guide (https://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 use AWSHealth 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 AWSHealth client 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 (
	ServiceName = "AWSHealth" // Service's name
	ServiceID   = "Health"    // Service's identifier
	EndpointsID = "health"    // Service's Endpoint identifier
)
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"
)

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"`

	EntityUrl *string `locationName:"entityUrl" 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/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 `locationName:"eventArn" type:"string"`

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

	// 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) String 

func (s AffectedEntity) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

The client's 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) *Client

New creates a new instance of the client from the provided Config.

Example: 

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

func (*Client) DescribeAffectedEntitiesRequest added in v0.9.0 

func (c *Client) 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 DescribeAffectedEntitiesRequest.
req := client.DescribeAffectedEntitiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEntityAggregatesRequest added in v0.9.0 

func (c *Client) 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 DescribeEntityAggregatesRequest.
req := client.DescribeEntityAggregatesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEventAggregatesRequest added in v0.9.0 

func (c *Client) 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 DescribeEventAggregatesRequest.
req := client.DescribeEventAggregatesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEventDetailsRequest added in v0.9.0 

func (c *Client) 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 DescribeEventDetailsRequest.
req := client.DescribeEventDetailsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEventTypesRequest added in v0.9.0 

func (c *Client) 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 DescribeEventTypesRequest.
req := client.DescribeEventTypesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEventsRequest added in v0.9.0 

func (c *Client) 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 DescribeEventsRequest.
req := client.DescribeEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type DateTimeRange 

type DateTimeRange struct {

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

	// The ending date and time of a time range.
	To *time.Time `locationName:"to" type:"timestamp"`
	// 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) 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) String 

func (s DescribeAffectedEntitiesInput) String() 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) String 

func (s DescribeAffectedEntitiesOutput) String() string

String returns the string representation

type DescribeAffectedEntitiesPaginator added in v0.9.0 

type DescribeAffectedEntitiesPaginator struct {
	aws.Pager
}

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

func NewDescribeAffectedEntitiesPaginator added in v0.9.0 

func NewDescribeAffectedEntitiesPaginator(req DescribeAffectedEntitiesRequest) DescribeAffectedEntitiesPaginator

NewDescribeAffectedEntitiesRequestPaginator returns a paginator for DescribeAffectedEntities. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeAffectedEntitiesRequest(input)
p := health.NewDescribeAffectedEntitiesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

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

func (*DescribeAffectedEntitiesPaginator) CurrentPage added in v0.9.0 

func (p *DescribeAffectedEntitiesPaginator) CurrentPage() *DescribeAffectedEntitiesOutput

type DescribeAffectedEntitiesRequest 

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

DescribeAffectedEntitiesRequest is the request type for the DescribeAffectedEntities API operation.

func (DescribeAffectedEntitiesRequest) Send 

func (r DescribeAffectedEntitiesRequest) Send(ctx context.Context) (*DescribeAffectedEntitiesResponse, error)

Send marshals and sends the DescribeAffectedEntities API request.

type DescribeAffectedEntitiesResponse added in v0.9.0 

type DescribeAffectedEntitiesResponse struct {
	*DescribeAffectedEntitiesOutput
	// contains filtered or unexported fields
}

DescribeAffectedEntitiesResponse is the response type for the DescribeAffectedEntities API operation.

func (*DescribeAffectedEntitiesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeAffectedEntitiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAffectedEntities request.

type DescribeEntityAggregatesInput 

type DescribeEntityAggregatesInput 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"
	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) String 

func (s DescribeEntityAggregatesInput) String() 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) String 

func (s DescribeEntityAggregatesOutput) String() string

String returns the string representation

type DescribeEntityAggregatesRequest 

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

DescribeEntityAggregatesRequest is the request type for the DescribeEntityAggregates API operation.

func (DescribeEntityAggregatesRequest) Send 

func (r DescribeEntityAggregatesRequest) Send(ctx context.Context) (*DescribeEntityAggregatesResponse, error)

Send marshals and sends the DescribeEntityAggregates API request.

type DescribeEntityAggregatesResponse added in v0.9.0 

type DescribeEntityAggregatesResponse struct {
	*DescribeEntityAggregatesOutput
	// contains filtered or unexported fields
}

DescribeEntityAggregatesResponse is the response type for the DescribeEntityAggregates API operation.

func (*DescribeEntityAggregatesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEntityAggregatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEntityAggregates 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) String 

func (s DescribeEventAggregatesInput) String() 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) String 

func (s DescribeEventAggregatesOutput) String() string

String returns the string representation

type DescribeEventAggregatesPaginator added in v0.9.0 

type DescribeEventAggregatesPaginator struct {
	aws.Pager
}

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

func NewDescribeEventAggregatesPaginator added in v0.9.0 

func NewDescribeEventAggregatesPaginator(req DescribeEventAggregatesRequest) DescribeEventAggregatesPaginator

NewDescribeEventAggregatesRequestPaginator returns a paginator for DescribeEventAggregates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeEventAggregatesRequest(input)
p := health.NewDescribeEventAggregatesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

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

func (*DescribeEventAggregatesPaginator) CurrentPage added in v0.9.0 

func (p *DescribeEventAggregatesPaginator) CurrentPage() *DescribeEventAggregatesOutput

type DescribeEventAggregatesRequest 

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

DescribeEventAggregatesRequest is the request type for the DescribeEventAggregates API operation.

func (DescribeEventAggregatesRequest) Send 

func (r DescribeEventAggregatesRequest) Send(ctx context.Context) (*DescribeEventAggregatesResponse, error)

Send marshals and sends the DescribeEventAggregates API request.

type DescribeEventAggregatesResponse added in v0.9.0 

type DescribeEventAggregatesResponse struct {
	*DescribeEventAggregatesOutput
	// contains filtered or unexported fields
}

DescribeEventAggregatesResponse is the response type for the DescribeEventAggregates API operation.

func (*DescribeEventAggregatesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventAggregatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEventAggregates request.

type DescribeEventDetailsInput 

type DescribeEventDetailsInput 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"
	//
	// 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) 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) String 

func (s DescribeEventDetailsOutput) String() string

String returns the string representation

type DescribeEventDetailsRequest 

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

DescribeEventDetailsRequest is the request type for the DescribeEventDetails API operation.

func (DescribeEventDetailsRequest) Send 

func (r DescribeEventDetailsRequest) Send(ctx context.Context) (*DescribeEventDetailsResponse, error)

Send marshals and sends the DescribeEventDetails API request.

type DescribeEventDetailsResponse added in v0.9.0 

type DescribeEventDetailsResponse struct {
	*DescribeEventDetailsOutput
	// contains filtered or unexported fields
}

DescribeEventDetailsResponse is the response type for the DescribeEventDetails API operation.

func (*DescribeEventDetailsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventDetailsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEventDetails 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) 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) String 

func (s DescribeEventTypesOutput) String() string

String returns the string representation

type DescribeEventTypesPaginator added in v0.9.0 

type DescribeEventTypesPaginator struct {
	aws.Pager
}

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

func NewDescribeEventTypesPaginator added in v0.9.0 

func NewDescribeEventTypesPaginator(req DescribeEventTypesRequest) DescribeEventTypesPaginator

NewDescribeEventTypesRequestPaginator returns a paginator for DescribeEventTypes. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeEventTypesRequest(input)
p := health.NewDescribeEventTypesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

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

func (*DescribeEventTypesPaginator) CurrentPage added in v0.9.0 

func (p *DescribeEventTypesPaginator) CurrentPage() *DescribeEventTypesOutput

type DescribeEventTypesRequest 

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

DescribeEventTypesRequest is the request type for the DescribeEventTypes API operation.

func (DescribeEventTypesRequest) Send 

func (r DescribeEventTypesRequest) Send(ctx context.Context) (*DescribeEventTypesResponse, error)

Send marshals and sends the DescribeEventTypes API request.

type DescribeEventTypesResponse added in v0.9.0 

type DescribeEventTypesResponse struct {
	*DescribeEventTypesOutput
	// contains filtered or unexported fields
}

DescribeEventTypesResponse is the response type for the DescribeEventTypes API operation.

func (*DescribeEventTypesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventTypesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEventTypes 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) 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) String 

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeEventsPaginator added in v0.9.0 

type DescribeEventsPaginator struct {
	aws.Pager
}

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

func NewDescribeEventsPaginator added in v0.9.0 

func NewDescribeEventsPaginator(req DescribeEventsRequest) DescribeEventsPaginator

NewDescribeEventsRequestPaginator returns a paginator for DescribeEvents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeEventsRequest(input)
p := health.NewDescribeEventsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

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

func (*DescribeEventsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeEventsPaginator) CurrentPage() *DescribeEventsOutput

type DescribeEventsRequest 

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

DescribeEventsRequest is the request type for the DescribeEvents API operation.

func (DescribeEventsRequest) Send 

func (r DescribeEventsRequest) Send(ctx context.Context) (*DescribeEventsResponse, error)

Send marshals and sends the DescribeEvents API request.

type DescribeEventsResponse added in v0.9.0 

type DescribeEventsResponse struct {
	*DescribeEventsOutput
	// contains filtered or unexported fields
}

DescribeEventsResponse is the response type for the DescribeEvents API operation.

func (*DescribeEventsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEvents 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/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 `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) 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/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 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) 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/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 `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"`

	// The category of the event. Possible values are issue, scheduledChange, and
	// accountNotification.
	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"`

	// 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"`

	// 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) 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) 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) 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) 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/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 `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) 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/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 `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) 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) 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"
	EventTypeCategoryInvestigation       EventTypeCategory = "investigation"
)

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) 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.

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.