health

package
v1.44.300 Latest Latest
Warning

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

 Go to latest Published: Jul 13, 2023 License: Apache-2.0 Imports: 10 Imported by: 37

Documentation

Overview

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

The Health API provides access to the Health information that appears in the Health Dashboard (https://health.aws.amazon.com/health/home). You can use the API operations to get information about events that might affect your Amazon Web Services and resources.

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support (http://aws.amazon.com/premiumsupport/) to use the Health API. If you call the Health API from an Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a SubscriptionRequiredException error.

For API access, you need an access key ID and a secret access key. Use temporary credentials instead of long-term access keys when possible. Temporary credentials include an access key ID, a secret access key, and a security token that indicates when the credentials expire. For more information, see Best practices for managing Amazon Web Services access keys (https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) in the Amazon Web Services General Reference.

You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see Accessing the Health API (https://docs.aws.amazon.com/health/latest/ug/health-api.html) in the Health User Guide.

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

If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating Health events (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in the Health User Guide.

When you use the Health API operations to return Health events, see the following recommendations:

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 contact 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 (
	// EntityStatusCodeImpaired is a EntityStatusCode enum value
	EntityStatusCodeImpaired = "IMPAIRED"

	// EntityStatusCodeUnimpaired is a EntityStatusCode enum value
	EntityStatusCodeUnimpaired = "UNIMPAIRED"

	// EntityStatusCodeUnknown is a EntityStatusCode enum value
	EntityStatusCodeUnknown = "UNKNOWN"
)
View Source 
const (
	// EventScopeCodePublic is a EventScopeCode enum value
	EventScopeCodePublic = "PUBLIC"

	// EventScopeCodeAccountSpecific is a EventScopeCode enum value
	EventScopeCodeAccountSpecific = "ACCOUNT_SPECIFIC"

	// EventScopeCodeNone is a EventScopeCode enum value
	EventScopeCodeNone = "NONE"
)
View Source 
const (
	// EventStatusCodeOpen is a EventStatusCode enum value
	EventStatusCodeOpen = "open"

	// EventStatusCodeClosed is a EventStatusCode enum value
	EventStatusCodeClosed = "closed"

	// EventStatusCodeUpcoming is a EventStatusCode enum value
	EventStatusCodeUpcoming = "upcoming"
)
View Source 
const (
	// EventTypeCategoryIssue is a EventTypeCategory enum value
	EventTypeCategoryIssue = "issue"

	// EventTypeCategoryAccountNotification is a EventTypeCategory enum value
	EventTypeCategoryAccountNotification = "accountNotification"

	// EventTypeCategoryScheduledChange is a EventTypeCategory enum value
	EventTypeCategoryScheduledChange = "scheduledChange"

	// EventTypeCategoryInvestigation is a EventTypeCategory enum value
	EventTypeCategoryInvestigation = "investigation"
)
View Source 
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html)
	// is already in progress. Wait for the action to complete before trying again.
	// To get the current status, use the DescribeHealthServiceStatusForOrganization
	// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeHealthServiceStatusForOrganization.html)
	// operation.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// 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"    // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Health"    // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// EventAggregateFieldEventTypeCategory is a EventAggregateField enum value
	EventAggregateFieldEventTypeCategory = "eventTypeCategory"
)

Variables

This section is empty.

Functions

func EntityStatusCode_Values added in v1.34.3 

func EntityStatusCode_Values() []string

EntityStatusCode_Values returns all elements of the EntityStatusCode enum

func EventAggregateField_Values added in v1.34.3 

func EventAggregateField_Values() []string

EventAggregateField_Values returns all elements of the EventAggregateField enum

func EventScopeCode_Values added in v1.34.3 

func EventScopeCode_Values() []string

EventScopeCode_Values returns all elements of the EventScopeCode enum

func EventStatusCode_Values added in v1.34.3 

func EventStatusCode_Values() []string

EventStatusCode_Values returns all elements of the EventStatusCode enum

func EventTypeCategory_Values added in v1.34.3 

func EventTypeCategory_Values() []string

EventTypeCategory_Values returns all elements of the EventTypeCategory enum

Types

type AffectedEntity 

type AffectedEntity struct {

	// The 12-digit Amazon Web Services 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 URL of the affected entity.
	EntityUrl *string `locationName:"entityUrl" type:"string"`

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

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// 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 *string `locationName:"statusCode" type:"string" enum:"EntityStatusCode"`

	// A map of entity tags attached to the affected entity.
	//
	// Currently, the tags property isn't supported.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

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

func (AffectedEntity) GoString 

func (s AffectedEntity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AffectedEntity) SetAwsAccountId 

func (s *AffectedEntity) SetAwsAccountId(v string) *AffectedEntity

SetAwsAccountId sets the AwsAccountId field's value.

func (*AffectedEntity) SetEntityArn 

func (s *AffectedEntity) SetEntityArn(v string) *AffectedEntity

SetEntityArn sets the EntityArn field's value.

func (*AffectedEntity) SetEntityUrl added in v1.15.90 

func (s *AffectedEntity) SetEntityUrl(v string) *AffectedEntity

SetEntityUrl sets the EntityUrl field's value.

func (*AffectedEntity) SetEntityValue 

func (s *AffectedEntity) SetEntityValue(v string) *AffectedEntity

SetEntityValue sets the EntityValue field's value.

func (*AffectedEntity) SetEventArn 

func (s *AffectedEntity) SetEventArn(v string) *AffectedEntity

SetEventArn sets the EventArn field's value.

func (*AffectedEntity) SetLastUpdatedTime 

func (s *AffectedEntity) SetLastUpdatedTime(v time.Time) *AffectedEntity

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*AffectedEntity) SetStatusCode 

func (s *AffectedEntity) SetStatusCode(v string) *AffectedEntity

SetStatusCode sets the StatusCode field's value.

func (*AffectedEntity) SetTags 

func (s *AffectedEntity) SetTags(v map[string]*string) *AffectedEntity

SetTags sets the Tags field's value.

func (AffectedEntity) String 

func (s AffectedEntity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConcurrentModificationException added in v1.28.0 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeHealthServiceStatusForOrganization.html) operation.

func (*ConcurrentModificationException) Code added in v1.28.0 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString added in v1.28.0 

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentModificationException) Message added in v1.28.0 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0 

func (s ConcurrentModificationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html) and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html) 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.

func (DateTimeRange) GoString 

func (s DateTimeRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DateTimeRange) SetFrom 

func (s *DateTimeRange) SetFrom(v time.Time) *DateTimeRange

SetFrom sets the From field's value.

func (*DateTimeRange) SetTo 

func (s *DateTimeRange) SetTo(v time.Time) *DateTimeRange

SetTo sets the To field's value.

func (DateTimeRange) String 

func (s DateTimeRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAffectedAccountsForOrganizationInput added in v1.26.8 

type DescribeAffectedAccountsForOrganizationInput struct {

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	//
	// EventArn is a required field
	EventArn *string `locationName:"eventArn" type:"string" required:"true"`

	// 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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAffectedAccountsForOrganizationInput) GoString added in v1.26.8 

func (s DescribeAffectedAccountsForOrganizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedAccountsForOrganizationInput) SetEventArn added in v1.26.8 

func (s *DescribeAffectedAccountsForOrganizationInput) SetEventArn(v string) *DescribeAffectedAccountsForOrganizationInput

SetEventArn sets the EventArn field's value.

func (*DescribeAffectedAccountsForOrganizationInput) SetMaxResults added in v1.26.8 

func (s *DescribeAffectedAccountsForOrganizationInput) SetMaxResults(v int64) *DescribeAffectedAccountsForOrganizationInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeAffectedAccountsForOrganizationInput) SetNextToken added in v1.26.8 

func (s *DescribeAffectedAccountsForOrganizationInput) SetNextToken(v string) *DescribeAffectedAccountsForOrganizationInput

SetNextToken sets the NextToken field's value.

func (DescribeAffectedAccountsForOrganizationInput) String added in v1.26.8 

func (s DescribeAffectedAccountsForOrganizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedAccountsForOrganizationInput) Validate added in v1.26.8 

func (s *DescribeAffectedAccountsForOrganizationInput) Validate() error

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

type DescribeAffectedAccountsForOrganizationOutput added in v1.26.8 

type DescribeAffectedAccountsForOrganizationOutput struct {

	// A JSON set of elements of the affected accounts.
	AffectedAccounts []*string `locationName:"affectedAccounts" type:"list"`

	// This parameter specifies if the Health event is a public Amazon Web Service
	// event or an account-specific event.
	//
	//    * If the eventScopeCode value is PUBLIC, then the affectedAccounts value
	//    is always empty.
	//
	//    * If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts
	//    value lists the affected Amazon Web Services accounts in your organization.
	//    For example, if an event affects a service such as Amazon Elastic Compute
	//    Cloud and you have Amazon Web Services accounts that use that service,
	//    those account IDs appear in the response.
	//
	//    * If the eventScopeCode value is NONE, then the eventArn that you specified
	//    in the request is invalid or doesn't exist.
	EventScopeCode *string `locationName:"eventScopeCode" type:"string" enum:"EventScopeCode"`

	// 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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAffectedAccountsForOrganizationOutput) GoString added in v1.26.8 

func (s DescribeAffectedAccountsForOrganizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedAccountsForOrganizationOutput) SetAffectedAccounts added in v1.26.8 

func (s *DescribeAffectedAccountsForOrganizationOutput) SetAffectedAccounts(v []*string) *DescribeAffectedAccountsForOrganizationOutput

SetAffectedAccounts sets the AffectedAccounts field's value.

func (*DescribeAffectedAccountsForOrganizationOutput) SetEventScopeCode added in v1.31.1 

func (s *DescribeAffectedAccountsForOrganizationOutput) SetEventScopeCode(v string) *DescribeAffectedAccountsForOrganizationOutput

SetEventScopeCode sets the EventScopeCode field's value.

func (*DescribeAffectedAccountsForOrganizationOutput) SetNextToken added in v1.26.8 

func (s *DescribeAffectedAccountsForOrganizationOutput) SetNextToken(v string) *DescribeAffectedAccountsForOrganizationOutput

SetNextToken sets the NextToken field's value.

func (DescribeAffectedAccountsForOrganizationOutput) String added in v1.26.8 

func (s DescribeAffectedAccountsForOrganizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAffectedEntitiesForOrganizationInput added in v1.26.8 

type DescribeAffectedEntitiesForOrganizationInput struct {

	// 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:"1" 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" min:"4" type:"string"`

	// A JSON set of elements including the awsAccountId and the eventArn.
	//
	// OrganizationEntityFilters is a required field
	OrganizationEntityFilters []*EventAccountFilter `locationName:"organizationEntityFilters" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAffectedEntitiesForOrganizationInput) GoString added in v1.26.8 

func (s DescribeAffectedEntitiesForOrganizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedEntitiesForOrganizationInput) SetLocale added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationInput) SetLocale(v string) *DescribeAffectedEntitiesForOrganizationInput

SetLocale sets the Locale field's value.

func (*DescribeAffectedEntitiesForOrganizationInput) SetMaxResults added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationInput) SetMaxResults(v int64) *DescribeAffectedEntitiesForOrganizationInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeAffectedEntitiesForOrganizationInput) SetNextToken added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationInput) SetNextToken(v string) *DescribeAffectedEntitiesForOrganizationInput

SetNextToken sets the NextToken field's value.

func (*DescribeAffectedEntitiesForOrganizationInput) SetOrganizationEntityFilters added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationInput) SetOrganizationEntityFilters(v []*EventAccountFilter) *DescribeAffectedEntitiesForOrganizationInput

SetOrganizationEntityFilters sets the OrganizationEntityFilters field's value.

func (DescribeAffectedEntitiesForOrganizationInput) String added in v1.26.8 

func (s DescribeAffectedEntitiesForOrganizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedEntitiesForOrganizationInput) Validate added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationInput) Validate() error

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

type DescribeAffectedEntitiesForOrganizationOutput added in v1.26.8 

type DescribeAffectedEntitiesForOrganizationOutput struct {

	// A JSON set of elements including the awsAccountId and its entityArn, entityValue
	// and its entityArn, lastUpdatedTime, and statusCode.
	Entities []*AffectedEntity `locationName:"entities" type:"list"`

	// A JSON set of elements of the failed response, including the awsAccountId,
	// errorMessage, errorName, and eventArn.
	FailedSet []*OrganizationAffectedEntitiesErrorItem `locationName:"failedSet" 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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAffectedEntitiesForOrganizationOutput) GoString added in v1.26.8 

func (s DescribeAffectedEntitiesForOrganizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedEntitiesForOrganizationOutput) SetEntities added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationOutput) SetEntities(v []*AffectedEntity) *DescribeAffectedEntitiesForOrganizationOutput

SetEntities sets the Entities field's value.

func (*DescribeAffectedEntitiesForOrganizationOutput) SetFailedSet added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationOutput) SetFailedSet(v []*OrganizationAffectedEntitiesErrorItem) *DescribeAffectedEntitiesForOrganizationOutput

SetFailedSet sets the FailedSet field's value.

func (*DescribeAffectedEntitiesForOrganizationOutput) SetNextToken added in v1.26.8 

func (s *DescribeAffectedEntitiesForOrganizationOutput) SetNextToken(v string) *DescribeAffectedEntitiesForOrganizationOutput

SetNextToken sets the NextToken field's value.

func (DescribeAffectedEntitiesForOrganizationOutput) String added in v1.26.8 

func (s DescribeAffectedEntitiesForOrganizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAffectedEntitiesInput) GoString 

func (s DescribeAffectedEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedEntitiesInput) SetFilter 

func (s *DescribeAffectedEntitiesInput) SetFilter(v *EntityFilter) *DescribeAffectedEntitiesInput

SetFilter sets the Filter field's value.

func (*DescribeAffectedEntitiesInput) SetLocale 

func (s *DescribeAffectedEntitiesInput) SetLocale(v string) *DescribeAffectedEntitiesInput

SetLocale sets the Locale field's value.

func (*DescribeAffectedEntitiesInput) SetMaxResults 

func (s *DescribeAffectedEntitiesInput) SetMaxResults(v int64) *DescribeAffectedEntitiesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeAffectedEntitiesInput) SetNextToken 

func (s *DescribeAffectedEntitiesInput) SetNextToken(v string) *DescribeAffectedEntitiesInput

SetNextToken sets the NextToken field's value.

func (DescribeAffectedEntitiesInput) String 

func (s DescribeAffectedEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAffectedEntitiesOutput) GoString 

func (s DescribeAffectedEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAffectedEntitiesOutput) SetEntities 

func (s *DescribeAffectedEntitiesOutput) SetEntities(v []*AffectedEntity) *DescribeAffectedEntitiesOutput

SetEntities sets the Entities field's value.

func (*DescribeAffectedEntitiesOutput) SetNextToken 

func (s *DescribeAffectedEntitiesOutput) SetNextToken(v string) *DescribeAffectedEntitiesOutput

SetNextToken sets the NextToken field's value.

func (DescribeAffectedEntitiesOutput) String 

func (s DescribeAffectedEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DescribeEntityAggregatesInput) GoString 

func (s DescribeEntityAggregatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntityAggregatesInput) SetEventArns 

func (s *DescribeEntityAggregatesInput) SetEventArns(v []*string) *DescribeEntityAggregatesInput

SetEventArns sets the EventArns field's value.

func (DescribeEntityAggregatesInput) String 

func (s DescribeEntityAggregatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DescribeEntityAggregatesOutput) GoString 

func (s DescribeEntityAggregatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntityAggregatesOutput) SetEntityAggregates 

func (s *DescribeEntityAggregatesOutput) SetEntityAggregates(v []*EntityAggregate) *DescribeEntityAggregatesOutput

SetEntityAggregates sets the EntityAggregates field's value.

func (DescribeEntityAggregatesOutput) String 

func (s DescribeEntityAggregatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventAggregatesInput 

type DescribeEventAggregatesInput struct {

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

	// 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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventAggregatesInput) GoString 

func (s DescribeEventAggregatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventAggregatesInput) SetAggregateField 

func (s *DescribeEventAggregatesInput) SetAggregateField(v string) *DescribeEventAggregatesInput

SetAggregateField sets the AggregateField field's value.

func (*DescribeEventAggregatesInput) SetFilter 

func (s *DescribeEventAggregatesInput) SetFilter(v *EventFilter) *DescribeEventAggregatesInput

SetFilter sets the Filter field's value.

func (*DescribeEventAggregatesInput) SetMaxResults 

func (s *DescribeEventAggregatesInput) SetMaxResults(v int64) *DescribeEventAggregatesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeEventAggregatesInput) SetNextToken 

func (s *DescribeEventAggregatesInput) SetNextToken(v string) *DescribeEventAggregatesInput

SetNextToken sets the NextToken field's value.

func (DescribeEventAggregatesInput) String 

func (s DescribeEventAggregatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventAggregatesOutput) GoString 

func (s DescribeEventAggregatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventAggregatesOutput) SetEventAggregates 

func (s *DescribeEventAggregatesOutput) SetEventAggregates(v []*EventAggregate) *DescribeEventAggregatesOutput

SetEventAggregates sets the EventAggregates field's value.

func (*DescribeEventAggregatesOutput) SetNextToken 

func (s *DescribeEventAggregatesOutput) SetNextToken(v string) *DescribeEventAggregatesOutput

SetNextToken sets the NextToken field's value.

func (DescribeEventAggregatesOutput) String 

func (s DescribeEventAggregatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventDetailsForOrganizationInput added in v1.26.8 

type DescribeEventDetailsForOrganizationInput struct {

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

	// A set of JSON elements that includes the awsAccountId and the eventArn.
	//
	// OrganizationEventDetailFilters is a required field
	OrganizationEventDetailFilters []*EventAccountFilter `locationName:"organizationEventDetailFilters" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEventDetailsForOrganizationInput) GoString added in v1.26.8 

func (s DescribeEventDetailsForOrganizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventDetailsForOrganizationInput) SetLocale added in v1.26.8 

func (s *DescribeEventDetailsForOrganizationInput) SetLocale(v string) *DescribeEventDetailsForOrganizationInput

SetLocale sets the Locale field's value.

func (*DescribeEventDetailsForOrganizationInput) SetOrganizationEventDetailFilters added in v1.26.8 

func (s *DescribeEventDetailsForOrganizationInput) SetOrganizationEventDetailFilters(v []*EventAccountFilter) *DescribeEventDetailsForOrganizationInput

SetOrganizationEventDetailFilters sets the OrganizationEventDetailFilters field's value.

func (DescribeEventDetailsForOrganizationInput) String added in v1.26.8 

func (s DescribeEventDetailsForOrganizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventDetailsForOrganizationInput) Validate added in v1.26.8 

func (s *DescribeEventDetailsForOrganizationInput) Validate() error

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

type DescribeEventDetailsForOrganizationOutput added in v1.26.8 

type DescribeEventDetailsForOrganizationOutput struct {

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

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

func (DescribeEventDetailsForOrganizationOutput) GoString added in v1.26.8 

func (s DescribeEventDetailsForOrganizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventDetailsForOrganizationOutput) SetFailedSet added in v1.26.8 

func (s *DescribeEventDetailsForOrganizationOutput) SetFailedSet(v []*OrganizationEventDetailsErrorItem) *DescribeEventDetailsForOrganizationOutput

SetFailedSet sets the FailedSet field's value.

func (*DescribeEventDetailsForOrganizationOutput) SetSuccessfulSet added in v1.26.8 

func (s *DescribeEventDetailsForOrganizationOutput) SetSuccessfulSet(v []*OrganizationEventDetails) *DescribeEventDetailsForOrganizationOutput

SetSuccessfulSet sets the SuccessfulSet field's value.

func (DescribeEventDetailsForOrganizationOutput) String added in v1.26.8 

func (s DescribeEventDetailsForOrganizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DescribeEventDetailsInput) GoString 

func (s DescribeEventDetailsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventDetailsInput) SetEventArns 

func (s *DescribeEventDetailsInput) SetEventArns(v []*string) *DescribeEventDetailsInput

SetEventArns sets the EventArns field's value.

func (*DescribeEventDetailsInput) SetLocale 

func (s *DescribeEventDetailsInput) SetLocale(v string) *DescribeEventDetailsInput

SetLocale sets the Locale field's value.

func (DescribeEventDetailsInput) String 

func (s DescribeEventDetailsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

func (DescribeEventDetailsOutput) GoString 

func (s DescribeEventDetailsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventDetailsOutput) SetFailedSet 

func (s *DescribeEventDetailsOutput) SetFailedSet(v []*EventDetailsErrorItem) *DescribeEventDetailsOutput

SetFailedSet sets the FailedSet field's value.

func (*DescribeEventDetailsOutput) SetSuccessfulSet 

func (s *DescribeEventDetailsOutput) SetSuccessfulSet(v []*EventDetails) *DescribeEventDetailsOutput

SetSuccessfulSet sets the SuccessfulSet field's value.

func (DescribeEventDetailsOutput) String 

func (s DescribeEventDetailsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// If you don't specify the maxResults parameter, this operation returns a maximum
	// of 30 items by default.
	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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventTypesInput) GoString 

func (s DescribeEventTypesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventTypesInput) SetFilter 

func (s *DescribeEventTypesInput) SetFilter(v *EventTypeFilter) *DescribeEventTypesInput

SetFilter sets the Filter field's value.

func (*DescribeEventTypesInput) SetLocale 

func (s *DescribeEventTypesInput) SetLocale(v string) *DescribeEventTypesInput

SetLocale sets the Locale field's value.

func (*DescribeEventTypesInput) SetMaxResults 

func (s *DescribeEventTypesInput) SetMaxResults(v int64) *DescribeEventTypesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeEventTypesInput) SetNextToken 

func (s *DescribeEventTypesInput) SetNextToken(v string) *DescribeEventTypesInput

SetNextToken sets the NextToken field's value.

func (DescribeEventTypesInput) String 

func (s DescribeEventTypesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventTypesOutput) GoString 

func (s DescribeEventTypesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventTypesOutput) SetEventTypes 

func (s *DescribeEventTypesOutput) SetEventTypes(v []*EventType) *DescribeEventTypesOutput

SetEventTypes sets the EventTypes field's value.

func (*DescribeEventTypesOutput) SetNextToken 

func (s *DescribeEventTypesOutput) SetNextToken(v string) *DescribeEventTypesOutput

SetNextToken sets the NextToken field's value.

func (DescribeEventTypesOutput) String 

func (s DescribeEventTypesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventsForOrganizationInput added in v1.26.8 

type DescribeEventsForOrganizationInput struct {

	// Values to narrow the results returned.
	Filter *OrganizationEventFilter `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:"1" 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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventsForOrganizationInput) GoString added in v1.26.8 

func (s DescribeEventsForOrganizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsForOrganizationInput) SetFilter added in v1.26.8 

func (s *DescribeEventsForOrganizationInput) SetFilter(v *OrganizationEventFilter) *DescribeEventsForOrganizationInput

SetFilter sets the Filter field's value.

func (*DescribeEventsForOrganizationInput) SetLocale added in v1.26.8 

func (s *DescribeEventsForOrganizationInput) SetLocale(v string) *DescribeEventsForOrganizationInput

SetLocale sets the Locale field's value.

func (*DescribeEventsForOrganizationInput) SetMaxResults added in v1.26.8 

func (s *DescribeEventsForOrganizationInput) SetMaxResults(v int64) *DescribeEventsForOrganizationInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeEventsForOrganizationInput) SetNextToken added in v1.26.8 

func (s *DescribeEventsForOrganizationInput) SetNextToken(v string) *DescribeEventsForOrganizationInput

SetNextToken sets the NextToken field's value.

func (DescribeEventsForOrganizationInput) String added in v1.26.8 

func (s DescribeEventsForOrganizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsForOrganizationInput) Validate added in v1.26.8 

func (s *DescribeEventsForOrganizationInput) Validate() error

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

type DescribeEventsForOrganizationOutput added in v1.26.8 

type DescribeEventsForOrganizationOutput struct {

	// The events that match the specified filter criteria.
	Events []*OrganizationEvent `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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventsForOrganizationOutput) GoString added in v1.26.8 

func (s DescribeEventsForOrganizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsForOrganizationOutput) SetEvents added in v1.26.8 

func (s *DescribeEventsForOrganizationOutput) SetEvents(v []*OrganizationEvent) *DescribeEventsForOrganizationOutput

SetEvents sets the Events field's value.

func (*DescribeEventsForOrganizationOutput) SetNextToken added in v1.26.8 

func (s *DescribeEventsForOrganizationOutput) SetNextToken(v string) *DescribeEventsForOrganizationOutput

SetNextToken sets the NextToken field's value.

func (DescribeEventsForOrganizationOutput) String added in v1.26.8 

func (s DescribeEventsForOrganizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventsInput) GoString 

func (s DescribeEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsInput) SetFilter 

func (s *DescribeEventsInput) SetFilter(v *EventFilter) *DescribeEventsInput

SetFilter sets the Filter field's value.

func (*DescribeEventsInput) SetLocale 

func (s *DescribeEventsInput) SetLocale(v string) *DescribeEventsInput

SetLocale sets the Locale field's value.

func (*DescribeEventsInput) SetMaxResults 

func (s *DescribeEventsInput) SetMaxResults(v int64) *DescribeEventsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeEventsInput) SetNextToken 

func (s *DescribeEventsInput) SetNextToken(v string) *DescribeEventsInput

SetNextToken sets the NextToken field's value.

func (DescribeEventsInput) String 

func (s DescribeEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventsOutput) GoString 

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsOutput) SetEvents 

func (s *DescribeEventsOutput) SetEvents(v []*Event) *DescribeEventsOutput

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetNextToken 

func (s *DescribeEventsOutput) SetNextToken(v string) *DescribeEventsOutput

SetNextToken sets the NextToken field's value.

func (DescribeEventsOutput) String 

func (s DescribeEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeHealthServiceStatusForOrganizationInput added in v1.26.8 

type DescribeHealthServiceStatusForOrganizationInput struct {
	// contains filtered or unexported fields
}

func (DescribeHealthServiceStatusForOrganizationInput) GoString added in v1.26.8 

func (s DescribeHealthServiceStatusForOrganizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeHealthServiceStatusForOrganizationInput) String added in v1.26.8 

func (s DescribeHealthServiceStatusForOrganizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeHealthServiceStatusForOrganizationOutput added in v1.26.8 

type DescribeHealthServiceStatusForOrganizationOutput struct {

	// Information about the status of enabling or disabling the Health organizational
	// view feature in your organization.
	//
	// Valid values are ENABLED | DISABLED | PENDING.
	HealthServiceAccessStatusForOrganization *string `locationName:"healthServiceAccessStatusForOrganization" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeHealthServiceStatusForOrganizationOutput) GoString added in v1.26.8 

func (s DescribeHealthServiceStatusForOrganizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeHealthServiceStatusForOrganizationOutput) SetHealthServiceAccessStatusForOrganization added in v1.26.8 

func (s *DescribeHealthServiceStatusForOrganizationOutput) SetHealthServiceAccessStatusForOrganization(v string) *DescribeHealthServiceStatusForOrganizationOutput

SetHealthServiceAccessStatusForOrganization sets the HealthServiceAccessStatusForOrganization field's value.

func (DescribeHealthServiceStatusForOrganizationOutput) String added in v1.26.8 

func (s DescribeHealthServiceStatusForOrganizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableHealthServiceAccessForOrganizationInput added in v1.26.8 

type DisableHealthServiceAccessForOrganizationInput struct {
	// contains filtered or unexported fields
}

func (DisableHealthServiceAccessForOrganizationInput) GoString added in v1.26.8 

func (s DisableHealthServiceAccessForOrganizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableHealthServiceAccessForOrganizationInput) String added in v1.26.8 

func (s DisableHealthServiceAccessForOrganizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableHealthServiceAccessForOrganizationOutput added in v1.26.8 

type DisableHealthServiceAccessForOrganizationOutput struct {
	// contains filtered or unexported fields
}

func (DisableHealthServiceAccessForOrganizationOutput) GoString added in v1.26.8 

func (s DisableHealthServiceAccessForOrganizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableHealthServiceAccessForOrganizationOutput) String added in v1.26.8 

func (s DisableHealthServiceAccessForOrganizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnableHealthServiceAccessForOrganizationInput added in v1.26.8 

type EnableHealthServiceAccessForOrganizationInput struct {
	// contains filtered or unexported fields
}

func (EnableHealthServiceAccessForOrganizationInput) GoString added in v1.26.8 

func (s EnableHealthServiceAccessForOrganizationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (EnableHealthServiceAccessForOrganizationInput) String added in v1.26.8 

func (s EnableHealthServiceAccessForOrganizationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnableHealthServiceAccessForOrganizationOutput added in v1.26.8 

type EnableHealthServiceAccessForOrganizationOutput struct {
	// contains filtered or unexported fields
}

func (EnableHealthServiceAccessForOrganizationOutput) GoString added in v1.26.8 

func (s EnableHealthServiceAccessForOrganizationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (EnableHealthServiceAccessForOrganizationOutput) String added in v1.26.8 

func (s EnableHealthServiceAccessForOrganizationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EntityAggregate 

type EntityAggregate struct {

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

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// 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 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html) operation.

func (EntityAggregate) GoString 

func (s EntityAggregate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityAggregate) SetCount 

func (s *EntityAggregate) SetCount(v int64) *EntityAggregate

SetCount sets the Count field's value.

func (*EntityAggregate) SetEventArn 

func (s *EntityAggregate) SetEventArn(v string) *EntityAggregate

SetEventArn sets the EventArn field's value.

func (EntityAggregate) String 

func (s EntityAggregate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 []*string `locationName:"statusCodes" min:"1" type:"list" enum:"EntityStatusCode"`

	// A map of entity tags attached to the affected entity.
	//
	// Currently, the tags property isn't supported.
	Tags []map[string]*string `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

The values to use to filter results from the DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) operation.

func (EntityFilter) GoString 

func (s EntityFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityFilter) SetEntityArns 

func (s *EntityFilter) SetEntityArns(v []*string) *EntityFilter

SetEntityArns sets the EntityArns field's value.

func (*EntityFilter) SetEntityValues 

func (s *EntityFilter) SetEntityValues(v []*string) *EntityFilter

SetEntityValues sets the EntityValues field's value.

func (*EntityFilter) SetEventArns 

func (s *EntityFilter) SetEventArns(v []*string) *EntityFilter

SetEventArns sets the EventArns field's value.

func (*EntityFilter) SetLastUpdatedTimes 

func (s *EntityFilter) SetLastUpdatedTimes(v []*DateTimeRange) *EntityFilter

SetLastUpdatedTimes sets the LastUpdatedTimes field's value.

func (*EntityFilter) SetStatusCodes 

func (s *EntityFilter) SetStatusCodes(v []*string) *EntityFilter

SetStatusCodes sets the StatusCodes field's value.

func (*EntityFilter) SetTags 

func (s *EntityFilter) SetTags(v []map[string]*string) *EntityFilter

SetTags sets the Tags field's value.

func (EntityFilter) String 

func (s EntityFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityFilter) Validate 

func (s *EntityFilter) Validate() error

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

type Event 

type Event struct {

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// 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 Amazon Web Services Availability Zone of the event. For example, us-east-1a.
	AvailabilityZone *string `locationName:"availabilityZone" min:"6" type:"string"`

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

	// This parameter specifies if the Health event is a public Amazon Web Service
	// event or an account-specific event.
	//
	//    * If the eventScopeCode value is PUBLIC, then the affectedAccounts value
	//    is always empty.
	//
	//    * If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts
	//    value lists the affected Amazon Web Services accounts in your organization.
	//    For example, if an event affects a service such as Amazon Elastic Compute
	//    Cloud and you have Amazon Web Services accounts that use that service,
	//    those account IDs appear in the response.
	//
	//    * If the eventScopeCode value is NONE, then the eventArn that you specified
	//    in the request is invalid or doesn't exist.
	EventScopeCode *string `locationName:"eventScopeCode" type:"string" enum:"EventScopeCode"`

	// A list of event type category codes. Possible values are issue, accountNotification,
	// or scheduledChange. Currently, the investigation value isn't supported at
	// this time.
	EventTypeCategory *string `locationName:"eventTypeCategory" min:"3" type:"string" enum:"EventTypeCategory"`

	// 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 Amazon Web Services Region name of the event.
	Region *string `locationName:"region" min:"2" type:"string"`

	// The Amazon Web 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 *string `locationName:"statusCode" type:"string" enum:"EventStatusCode"`
	// contains filtered or unexported fields
}

Summary information about an Health event.

Health events can be public or account-specific:

  • Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.

  • Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.

You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode).

func (Event) GoString 

func (s Event) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Event) SetArn 

func (s *Event) SetArn(v string) *Event

SetArn sets the Arn field's value.

func (*Event) SetAvailabilityZone 

func (s *Event) SetAvailabilityZone(v string) *Event

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*Event) SetEndTime 

func (s *Event) SetEndTime(v time.Time) *Event

SetEndTime sets the EndTime field's value.

func (*Event) SetEventScopeCode added in v1.31.1 

func (s *Event) SetEventScopeCode(v string) *Event

SetEventScopeCode sets the EventScopeCode field's value.

func (*Event) SetEventTypeCategory 

func (s *Event) SetEventTypeCategory(v string) *Event

SetEventTypeCategory sets the EventTypeCategory field's value.

func (*Event) SetEventTypeCode 

func (s *Event) SetEventTypeCode(v string) *Event

SetEventTypeCode sets the EventTypeCode field's value.

func (*Event) SetLastUpdatedTime 

func (s *Event) SetLastUpdatedTime(v time.Time) *Event

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*Event) SetRegion 

func (s *Event) SetRegion(v string) *Event

SetRegion sets the Region field's value.

func (*Event) SetService 

func (s *Event) SetService(v string) *Event

SetService sets the Service field's value.

func (*Event) SetStartTime 

func (s *Event) SetStartTime(v time.Time) *Event

SetStartTime sets the StartTime field's value.

func (*Event) SetStatusCode 

func (s *Event) SetStatusCode(v string) *Event

SetStatusCode sets the StatusCode field's value.

func (Event) String 

func (s Event) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventAccountFilter added in v1.26.8 

type EventAccountFilter struct {

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AwsAccountId *string `locationName:"awsAccountId" type:"string"`

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
	//
	// EventArn is a required field
	EventArn *string `locationName:"eventArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The values used to filter results from the DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) and DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) operations.

func (EventAccountFilter) GoString added in v1.26.8 

func (s EventAccountFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventAccountFilter) SetAwsAccountId added in v1.26.8 

func (s *EventAccountFilter) SetAwsAccountId(v string) *EventAccountFilter

SetAwsAccountId sets the AwsAccountId field's value.

func (*EventAccountFilter) SetEventArn added in v1.26.8 

func (s *EventAccountFilter) SetEventArn(v string) *EventAccountFilter

SetEventArn sets the EventArn field's value.

func (EventAccountFilter) String added in v1.26.8 

func (s EventAccountFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventAccountFilter) Validate added in v1.26.8 

func (s *EventAccountFilter) Validate() error

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

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 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html) operation.

func (EventAggregate) GoString 

func (s EventAggregate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventAggregate) SetAggregateValue 

func (s *EventAggregate) SetAggregateValue(v string) *EventAggregate

SetAggregateValue sets the AggregateValue field's value.

func (*EventAggregate) SetCount 

func (s *EventAggregate) SetCount(v int64) *EventAggregate

SetCount sets the Count field's value.

func (EventAggregate) String 

func (s EventAggregate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) operation.

func (EventDescription) GoString 

func (s EventDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDescription) SetLatestDescription 

func (s *EventDescription) SetLatestDescription(v string) *EventDescription

SetLatestDescription sets the LatestDescription field's value.

func (EventDescription) String 

func (s EventDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) object, an EventDescription (https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html) object, and additional metadata about the event. Returned by the DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) operation.

func (EventDetails) GoString 

func (s EventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDetails) SetEvent 

func (s *EventDetails) SetEvent(v *Event) *EventDetails

SetEvent sets the Event field's value.

func (*EventDetails) SetEventDescription 

func (s *EventDetails) SetEventDescription(v *EventDescription) *EventDetails

SetEventDescription sets the EventDescription field's value.

func (*EventDetails) SetEventMetadata 

func (s *EventDetails) SetEventMetadata(v map[string]*string) *EventDetails

SetEventMetadata sets the EventMetadata field's value.

func (EventDetails) String 

func (s EventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// 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 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) operation can't find a specified event.

func (EventDetailsErrorItem) GoString 

func (s EventDetailsErrorItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventDetailsErrorItem) SetErrorMessage 

func (s *EventDetailsErrorItem) SetErrorMessage(v string) *EventDetailsErrorItem

SetErrorMessage sets the ErrorMessage field's value.

func (*EventDetailsErrorItem) SetErrorName 

func (s *EventDetailsErrorItem) SetErrorName(v string) *EventDetailsErrorItem

SetErrorName sets the ErrorName field's value.

func (*EventDetailsErrorItem) SetEventArn 

func (s *EventDetailsErrorItem) SetEventArn(v string) *EventDetailsErrorItem

SetEventArn sets the EventArn field's value.

func (EventDetailsErrorItem) String 

func (s EventDetailsErrorItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventFilter 

type EventFilter struct {

	// A list of Amazon Web Services 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 []*string `locationName:"eventStatusCodes" min:"1" type:"list" enum:"EventStatusCode"`

	// A list of event type category codes. Possible values are issue, accountNotification,
	// or scheduledChange. Currently, the investigation value isn't supported at
	// this time.
	EventTypeCategories []*string `locationName:"eventTypeCategories" min:"1" type:"list" enum:"EventTypeCategory"`

	// 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 Amazon Web Services Regions.
	Regions []*string `locationName:"regions" min:"1" type:"list"`

	// The Amazon Web 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.
	//
	// Currently, the tags property isn't supported.
	Tags []map[string]*string `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

The values to use to filter results from the DescribeEvents (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html) and DescribeEventAggregates (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html) operations.

func (EventFilter) GoString 

func (s EventFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventFilter) SetAvailabilityZones 

func (s *EventFilter) SetAvailabilityZones(v []*string) *EventFilter

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*EventFilter) SetEndTimes 

func (s *EventFilter) SetEndTimes(v []*DateTimeRange) *EventFilter

SetEndTimes sets the EndTimes field's value.

func (*EventFilter) SetEntityArns 

func (s *EventFilter) SetEntityArns(v []*string) *EventFilter

SetEntityArns sets the EntityArns field's value.

func (*EventFilter) SetEntityValues 

func (s *EventFilter) SetEntityValues(v []*string) *EventFilter

SetEntityValues sets the EntityValues field's value.

func (*EventFilter) SetEventArns 

func (s *EventFilter) SetEventArns(v []*string) *EventFilter

SetEventArns sets the EventArns field's value.

func (*EventFilter) SetEventStatusCodes 

func (s *EventFilter) SetEventStatusCodes(v []*string) *EventFilter

SetEventStatusCodes sets the EventStatusCodes field's value.

func (*EventFilter) SetEventTypeCategories 

func (s *EventFilter) SetEventTypeCategories(v []*string) *EventFilter

SetEventTypeCategories sets the EventTypeCategories field's value.

func (*EventFilter) SetEventTypeCodes 

func (s *EventFilter) SetEventTypeCodes(v []*string) *EventFilter

SetEventTypeCodes sets the EventTypeCodes field's value.

func (*EventFilter) SetLastUpdatedTimes 

func (s *EventFilter) SetLastUpdatedTimes(v []*DateTimeRange) *EventFilter

SetLastUpdatedTimes sets the LastUpdatedTimes field's value.

func (*EventFilter) SetRegions 

func (s *EventFilter) SetRegions(v []*string) *EventFilter

SetRegions sets the Regions field's value.

func (*EventFilter) SetServices 

func (s *EventFilter) SetServices(v []*string) *EventFilter

SetServices sets the Services field's value.

func (*EventFilter) SetStartTimes 

func (s *EventFilter) SetStartTimes(v []*DateTimeRange) *EventFilter

SetStartTimes sets the StartTimes field's value.

func (*EventFilter) SetTags 

func (s *EventFilter) SetTags(v []map[string]*string) *EventFilter

SetTags sets the Tags field's value.

func (EventFilter) String 

func (s EventFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventFilter) Validate 

func (s *EventFilter) Validate() error

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

type EventType 

type EventType struct {

	// A list of event type category codes. Possible values are issue, accountNotification,
	// or scheduledChange. Currently, the investigation value isn't supported at
	// this time.
	Category *string `locationName:"category" min:"3" type:"string" enum:"EventTypeCategory"`

	// 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 Amazon Web Service that is affected by the event. For example, EC2, RDS.
	Service *string `locationName:"service" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Contains the metadata about a type of event that is reported by Health. The EventType shows the category, service, and the event type code of the event. For example, an issue might be the category, EC2 the service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.

You can use the DescribeEventTypes (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html) API operation to return this information about an event.

You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see Monitor for Health events with Amazon CloudWatch Events (https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html) in the Health User Guide.

func (EventType) GoString 

func (s EventType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventType) SetCategory 

func (s *EventType) SetCategory(v string) *EventType

SetCategory sets the Category field's value.

func (*EventType) SetCode 

func (s *EventType) SetCode(v string) *EventType

SetCode sets the Code field's value.

func (*EventType) SetService 

func (s *EventType) SetService(v string) *EventType

SetService sets the Service field's value.

func (EventType) String 

func (s EventType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventTypeFilter 

type EventTypeFilter struct {

	// A list of event type category codes. Possible values are issue, accountNotification,
	// or scheduledChange. Currently, the investigation value isn't supported at
	// this time.
	EventTypeCategories []*string `locationName:"eventTypeCategories" min:"1" type:"list" enum:"EventTypeCategory"`

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

	// The Amazon Web 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 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html) operation.

func (EventTypeFilter) GoString 

func (s EventTypeFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventTypeFilter) SetEventTypeCategories 

func (s *EventTypeFilter) SetEventTypeCategories(v []*string) *EventTypeFilter

SetEventTypeCategories sets the EventTypeCategories field's value.

func (*EventTypeFilter) SetEventTypeCodes 

func (s *EventTypeFilter) SetEventTypeCodes(v []*string) *EventTypeFilter

SetEventTypeCodes sets the EventTypeCodes field's value.

func (*EventTypeFilter) SetServices 

func (s *EventTypeFilter) SetServices(v []*string) *EventTypeFilter

SetServices sets the Services field's value.

func (EventTypeFilter) String 

func (s EventTypeFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {
	*client.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(p client.ConfigProvider, cfgs ...*aws.Config) *Health

New creates a new instance of the Health client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a Health client from just a session.
svc := health.New(mySession)

// Create a Health client with additional configuration
svc := health.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Health) DescribeAffectedAccountsForOrganization added in v1.26.8 

func (c *Health) DescribeAffectedAccountsForOrganization(input *DescribeAffectedAccountsForOrganizationInput) (*DescribeAffectedAccountsForOrganizationOutput, error)

DescribeAffectedAccountsForOrganization API operation for AWS Health APIs and Notifications.

Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) operation from your organization's management account.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeAffectedAccountsForOrganization for usage and error information.

Returned Error Types:

  • InvalidPaginationToken The specified pagination token (nextToken) is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedAccountsForOrganization

func (*Health) DescribeAffectedAccountsForOrganizationPages added in v1.26.8 

func (c *Health) DescribeAffectedAccountsForOrganizationPages(input *DescribeAffectedAccountsForOrganizationInput, fn func(*DescribeAffectedAccountsForOrganizationOutput, bool) bool) error

DescribeAffectedAccountsForOrganizationPages iterates over the pages of a DescribeAffectedAccountsForOrganization operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAffectedAccountsForOrganization method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeAffectedAccountsForOrganization operation.
pageNum := 0
err := client.DescribeAffectedAccountsForOrganizationPages(params,
    func(page *health.DescribeAffectedAccountsForOrganizationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Health) DescribeAffectedAccountsForOrganizationPagesWithContext added in v1.26.8 

func (c *Health) DescribeAffectedAccountsForOrganizationPagesWithContext(ctx aws.Context, input *DescribeAffectedAccountsForOrganizationInput, fn func(*DescribeAffectedAccountsForOrganizationOutput, bool) bool, opts ...request.Option) error

DescribeAffectedAccountsForOrganizationPagesWithContext same as DescribeAffectedAccountsForOrganizationPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeAffectedAccountsForOrganizationRequest added in v1.26.8 

func (c *Health) DescribeAffectedAccountsForOrganizationRequest(input *DescribeAffectedAccountsForOrganizationInput) (req *request.Request, output *DescribeAffectedAccountsForOrganizationOutput)

DescribeAffectedAccountsForOrganizationRequest generates a "aws/request.Request" representing the client's request for the DescribeAffectedAccountsForOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAffectedAccountsForOrganization for more information on using the DescribeAffectedAccountsForOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAffectedAccountsForOrganizationRequest method.
req, resp := client.DescribeAffectedAccountsForOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedAccountsForOrganization

func (*Health) DescribeAffectedAccountsForOrganizationWithContext added in v1.26.8 

func (c *Health) DescribeAffectedAccountsForOrganizationWithContext(ctx aws.Context, input *DescribeAffectedAccountsForOrganizationInput, opts ...request.Option) (*DescribeAffectedAccountsForOrganizationOutput, error)

DescribeAffectedAccountsForOrganizationWithContext is the same as DescribeAffectedAccountsForOrganization with the addition of the ability to pass a context and additional request options.

See DescribeAffectedAccountsForOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeAffectedEntities 

func (c *Health) DescribeAffectedEntities(input *DescribeAffectedEntitiesInput) (*DescribeAffectedEntitiesOutput, error)

DescribeAffectedEntities 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 Amazon Web 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeAffectedEntities for usage and error information.

Returned Error Types:

  • InvalidPaginationToken The specified pagination token (nextToken) is not valid.

  • UnsupportedLocale The specified locale is not supported.

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

func (*Health) DescribeAffectedEntitiesForOrganization added in v1.26.8 

func (c *Health) DescribeAffectedEntitiesForOrganization(input *DescribeAffectedEntitiesForOrganizationInput) (*DescribeAffectedEntitiesForOrganizationOutput, error)

DescribeAffectedEntitiesForOrganization API operation for AWS Health APIs and Notifications.

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service.

At least one event Amazon Resource Name (ARN) and account ID are required.

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) operation from your organization's management account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeAffectedEntitiesForOrganization for usage and error information.

Returned Error Types:

  • InvalidPaginationToken The specified pagination token (nextToken) is not valid.

  • UnsupportedLocale The specified locale is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganization

func (*Health) DescribeAffectedEntitiesForOrganizationPages added in v1.26.8 

func (c *Health) DescribeAffectedEntitiesForOrganizationPages(input *DescribeAffectedEntitiesForOrganizationInput, fn func(*DescribeAffectedEntitiesForOrganizationOutput, bool) bool) error

DescribeAffectedEntitiesForOrganizationPages iterates over the pages of a DescribeAffectedEntitiesForOrganization operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAffectedEntitiesForOrganization method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeAffectedEntitiesForOrganization operation.
pageNum := 0
err := client.DescribeAffectedEntitiesForOrganizationPages(params,
    func(page *health.DescribeAffectedEntitiesForOrganizationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Health) DescribeAffectedEntitiesForOrganizationPagesWithContext added in v1.26.8 

func (c *Health) DescribeAffectedEntitiesForOrganizationPagesWithContext(ctx aws.Context, input *DescribeAffectedEntitiesForOrganizationInput, fn func(*DescribeAffectedEntitiesForOrganizationOutput, bool) bool, opts ...request.Option) error

DescribeAffectedEntitiesForOrganizationPagesWithContext same as DescribeAffectedEntitiesForOrganizationPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeAffectedEntitiesForOrganizationRequest added in v1.26.8 

func (c *Health) DescribeAffectedEntitiesForOrganizationRequest(input *DescribeAffectedEntitiesForOrganizationInput) (req *request.Request, output *DescribeAffectedEntitiesForOrganizationOutput)

DescribeAffectedEntitiesForOrganizationRequest generates a "aws/request.Request" representing the client's request for the DescribeAffectedEntitiesForOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAffectedEntitiesForOrganization for more information on using the DescribeAffectedEntitiesForOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAffectedEntitiesForOrganizationRequest method.
req, resp := client.DescribeAffectedEntitiesForOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganization

func (*Health) DescribeAffectedEntitiesForOrganizationWithContext added in v1.26.8 

func (c *Health) DescribeAffectedEntitiesForOrganizationWithContext(ctx aws.Context, input *DescribeAffectedEntitiesForOrganizationInput, opts ...request.Option) (*DescribeAffectedEntitiesForOrganizationOutput, error)

DescribeAffectedEntitiesForOrganizationWithContext is the same as DescribeAffectedEntitiesForOrganization with the addition of the ability to pass a context and additional request options.

See DescribeAffectedEntitiesForOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeAffectedEntitiesPages 

func (c *Health) DescribeAffectedEntitiesPages(input *DescribeAffectedEntitiesInput, fn func(*DescribeAffectedEntitiesOutput, bool) bool) error

DescribeAffectedEntitiesPages iterates over the pages of a DescribeAffectedEntities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAffectedEntities method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeAffectedEntities operation.
pageNum := 0
err := client.DescribeAffectedEntitiesPages(params,
    func(page *health.DescribeAffectedEntitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Health) DescribeAffectedEntitiesPagesWithContext added in v1.8.0 

func (c *Health) DescribeAffectedEntitiesPagesWithContext(ctx aws.Context, input *DescribeAffectedEntitiesInput, fn func(*DescribeAffectedEntitiesOutput, bool) bool, opts ...request.Option) error

DescribeAffectedEntitiesPagesWithContext same as DescribeAffectedEntitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeAffectedEntitiesRequest 

func (c *Health) DescribeAffectedEntitiesRequest(input *DescribeAffectedEntitiesInput) (req *request.Request, output *DescribeAffectedEntitiesOutput)

DescribeAffectedEntitiesRequest generates a "aws/request.Request" representing the client's request for the DescribeAffectedEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAffectedEntities for more information on using the DescribeAffectedEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAffectedEntitiesRequest method.
req, resp := client.DescribeAffectedEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Health) DescribeAffectedEntitiesWithContext added in v1.8.0 

func (c *Health) DescribeAffectedEntitiesWithContext(ctx aws.Context, input *DescribeAffectedEntitiesInput, opts ...request.Option) (*DescribeAffectedEntitiesOutput, error)

DescribeAffectedEntitiesWithContext is the same as DescribeAffectedEntities with the addition of the ability to pass a context and additional request options.

See DescribeAffectedEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEntityAggregates 

func (c *Health) DescribeEntityAggregates(input *DescribeEntityAggregatesInput) (*DescribeEntityAggregatesOutput, error)

DescribeEntityAggregates API operation for AWS Health APIs and Notifications.

Returns the number of entities that are affected by each of the specified events.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeEntityAggregates for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEntityAggregates

func (*Health) DescribeEntityAggregatesRequest 

func (c *Health) DescribeEntityAggregatesRequest(input *DescribeEntityAggregatesInput) (req *request.Request, output *DescribeEntityAggregatesOutput)

DescribeEntityAggregatesRequest generates a "aws/request.Request" representing the client's request for the DescribeEntityAggregates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEntityAggregates for more information on using the DescribeEntityAggregates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEntityAggregatesRequest method.
req, resp := client.DescribeEntityAggregatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Health) DescribeEntityAggregatesWithContext added in v1.8.0 

func (c *Health) DescribeEntityAggregatesWithContext(ctx aws.Context, input *DescribeEntityAggregatesInput, opts ...request.Option) (*DescribeEntityAggregatesOutput, error)

DescribeEntityAggregatesWithContext is the same as DescribeEntityAggregates with the addition of the ability to pass a context and additional request options.

See DescribeEntityAggregates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventAggregates 

func (c *Health) DescribeEventAggregates(input *DescribeEventAggregatesInput) (*DescribeEventAggregatesOutput, error)

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

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeEventAggregates for usage and error information.

Returned Error Types:

  • InvalidPaginationToken The specified pagination token (nextToken) is not valid.

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

func (*Health) DescribeEventAggregatesPages 

func (c *Health) DescribeEventAggregatesPages(input *DescribeEventAggregatesInput, fn func(*DescribeEventAggregatesOutput, bool) bool) error

DescribeEventAggregatesPages iterates over the pages of a DescribeEventAggregates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEventAggregates method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeEventAggregates operation.
pageNum := 0
err := client.DescribeEventAggregatesPages(params,
    func(page *health.DescribeEventAggregatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Health) DescribeEventAggregatesPagesWithContext added in v1.8.0 

func (c *Health) DescribeEventAggregatesPagesWithContext(ctx aws.Context, input *DescribeEventAggregatesInput, fn func(*DescribeEventAggregatesOutput, bool) bool, opts ...request.Option) error

DescribeEventAggregatesPagesWithContext same as DescribeEventAggregatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventAggregatesRequest 

func (c *Health) DescribeEventAggregatesRequest(input *DescribeEventAggregatesInput) (req *request.Request, output *DescribeEventAggregatesOutput)

DescribeEventAggregatesRequest generates a "aws/request.Request" representing the client's request for the DescribeEventAggregates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventAggregates for more information on using the DescribeEventAggregates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventAggregatesRequest method.
req, resp := client.DescribeEventAggregatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Health) DescribeEventAggregatesWithContext added in v1.8.0 

func (c *Health) DescribeEventAggregatesWithContext(ctx aws.Context, input *DescribeEventAggregatesInput, opts ...request.Option) (*DescribeEventAggregatesOutput, error)

DescribeEventAggregatesWithContext is the same as DescribeEventAggregates with the addition of the ability to pass a context and additional request options.

See DescribeEventAggregates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventDetails 

func (c *Health) DescribeEventDetails(input *DescribeEventDetailsInput) (*DescribeEventDetailsOutput, error)

DescribeEventDetails API operation for AWS Health APIs and Notifications.

Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html)), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) operation.

If a specified event can't be retrieved, an error message is returned for that event.

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) in the Health User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeEventDetails for usage and error information.

Returned Error Types:

  • UnsupportedLocale The specified locale is not supported.

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

func (*Health) DescribeEventDetailsForOrganization added in v1.26.8 

func (c *Health) DescribeEventDetailsForOrganization(input *DescribeEventDetailsForOrganizationInput) (*DescribeEventDetailsForOrganizationOutput, error)

DescribeEventDetailsForOrganization API operation for AWS Health APIs and Notifications.

Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) operation.

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) operation from your organization's management account.

When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:

  • To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.

  • To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.

For more information, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).

This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions) in the Health User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeEventDetailsForOrganization for usage and error information.

Returned Error Types:

  • UnsupportedLocale The specified locale is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsForOrganization

func (*Health) DescribeEventDetailsForOrganizationRequest added in v1.26.8 

func (c *Health) DescribeEventDetailsForOrganizationRequest(input *DescribeEventDetailsForOrganizationInput) (req *request.Request, output *DescribeEventDetailsForOrganizationOutput)

DescribeEventDetailsForOrganizationRequest generates a "aws/request.Request" representing the client's request for the DescribeEventDetailsForOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventDetailsForOrganization for more information on using the DescribeEventDetailsForOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventDetailsForOrganizationRequest method.
req, resp := client.DescribeEventDetailsForOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsForOrganization

func (*Health) DescribeEventDetailsForOrganizationWithContext added in v1.26.8 

func (c *Health) DescribeEventDetailsForOrganizationWithContext(ctx aws.Context, input *DescribeEventDetailsForOrganizationInput, opts ...request.Option) (*DescribeEventDetailsForOrganizationOutput, error)

DescribeEventDetailsForOrganizationWithContext is the same as DescribeEventDetailsForOrganization with the addition of the ability to pass a context and additional request options.

See DescribeEventDetailsForOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventDetailsRequest 

func (c *Health) DescribeEventDetailsRequest(input *DescribeEventDetailsInput) (req *request.Request, output *DescribeEventDetailsOutput)

DescribeEventDetailsRequest generates a "aws/request.Request" representing the client's request for the DescribeEventDetails operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventDetails for more information on using the DescribeEventDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventDetailsRequest method.
req, resp := client.DescribeEventDetailsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Health) DescribeEventDetailsWithContext added in v1.8.0 

func (c *Health) DescribeEventDetailsWithContext(ctx aws.Context, input *DescribeEventDetailsInput, opts ...request.Option) (*DescribeEventDetailsOutput, error)

DescribeEventDetailsWithContext is the same as DescribeEventDetails with the addition of the ability to pass a context and additional request options.

See DescribeEventDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventTypes 

func (c *Health) DescribeEventTypes(input *DescribeEventTypesInput) (*DescribeEventTypesOutput, error)

DescribeEventTypes API operation for AWS Health APIs and Notifications.

Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the EventType (https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html) object.

If you don't specify a filter criteria, the API operation returns all event types, in no particular order.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeEventTypes for usage and error information.

Returned Error Types:

  • InvalidPaginationToken The specified pagination token (nextToken) is not valid.

  • UnsupportedLocale The specified locale is not supported.

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

func (*Health) DescribeEventTypesPages 

func (c *Health) DescribeEventTypesPages(input *DescribeEventTypesInput, fn func(*DescribeEventTypesOutput, bool) bool) error

DescribeEventTypesPages iterates over the pages of a DescribeEventTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEventTypes method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeEventTypes operation.
pageNum := 0
err := client.DescribeEventTypesPages(params,
    func(page *health.DescribeEventTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Health) DescribeEventTypesPagesWithContext added in v1.8.0 

func (c *Health) DescribeEventTypesPagesWithContext(ctx aws.Context, input *DescribeEventTypesInput, fn func(*DescribeEventTypesOutput, bool) bool, opts ...request.Option) error

DescribeEventTypesPagesWithContext same as DescribeEventTypesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventTypesRequest 

func (c *Health) DescribeEventTypesRequest(input *DescribeEventTypesInput) (req *request.Request, output *DescribeEventTypesOutput)

DescribeEventTypesRequest generates a "aws/request.Request" representing the client's request for the DescribeEventTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventTypes for more information on using the DescribeEventTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventTypesRequest method.
req, resp := client.DescribeEventTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Health) DescribeEventTypesWithContext added in v1.8.0 

func (c *Health) DescribeEventTypesWithContext(ctx aws.Context, input *DescribeEventTypesInput, opts ...request.Option) (*DescribeEventTypesOutput, error)

DescribeEventTypesWithContext is the same as DescribeEventTypes with the addition of the ability to pass a context and additional request options.

See DescribeEventTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEvents 

func (c *Health) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

DescribeEvents 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 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) and DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) operations.

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

  • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).

  • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeEvents for usage and error information.

Returned Error Types:

  • InvalidPaginationToken The specified pagination token (nextToken) is not valid.

  • UnsupportedLocale The specified locale is not supported.

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

func (*Health) DescribeEventsForOrganization added in v1.26.8 

func (c *Health) DescribeEventsForOrganization(input *DescribeEventsForOrganizationInput) (*DescribeEventsForOrganizationOutput, error)

DescribeEventsForOrganization API operation for AWS Health APIs and Notifications.

Returns information about events across your organization in Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:

If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.

For more information about the different types of Health events, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) operation from your organization's management account.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeEventsForOrganization for usage and error information.

Returned Error Types:

  • InvalidPaginationToken The specified pagination token (nextToken) is not valid.

  • UnsupportedLocale The specified locale is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsForOrganization

func (*Health) DescribeEventsForOrganizationPages added in v1.26.8 

func (c *Health) DescribeEventsForOrganizationPages(input *DescribeEventsForOrganizationInput, fn func(*DescribeEventsForOrganizationOutput, bool) bool) error

DescribeEventsForOrganizationPages iterates over the pages of a DescribeEventsForOrganization operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEventsForOrganization method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeEventsForOrganization operation.
pageNum := 0
err := client.DescribeEventsForOrganizationPages(params,
    func(page *health.DescribeEventsForOrganizationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Health) DescribeEventsForOrganizationPagesWithContext added in v1.26.8 

func (c *Health) DescribeEventsForOrganizationPagesWithContext(ctx aws.Context, input *DescribeEventsForOrganizationInput, fn func(*DescribeEventsForOrganizationOutput, bool) bool, opts ...request.Option) error

DescribeEventsForOrganizationPagesWithContext same as DescribeEventsForOrganizationPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventsForOrganizationRequest added in v1.26.8 

func (c *Health) DescribeEventsForOrganizationRequest(input *DescribeEventsForOrganizationInput) (req *request.Request, output *DescribeEventsForOrganizationOutput)

DescribeEventsForOrganizationRequest generates a "aws/request.Request" representing the client's request for the DescribeEventsForOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventsForOrganization for more information on using the DescribeEventsForOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventsForOrganizationRequest method.
req, resp := client.DescribeEventsForOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsForOrganization

func (*Health) DescribeEventsForOrganizationWithContext added in v1.26.8 

func (c *Health) DescribeEventsForOrganizationWithContext(ctx aws.Context, input *DescribeEventsForOrganizationInput, opts ...request.Option) (*DescribeEventsForOrganizationOutput, error)

DescribeEventsForOrganizationWithContext is the same as DescribeEventsForOrganization with the addition of the ability to pass a context and additional request options.

See DescribeEventsForOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventsPages 

func (c *Health) DescribeEventsPages(input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool) error

DescribeEventsPages iterates over the pages of a DescribeEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeEvents method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeEvents operation.
pageNum := 0
err := client.DescribeEventsPages(params,
    func(page *health.DescribeEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Health) DescribeEventsPagesWithContext added in v1.8.0 

func (c *Health) DescribeEventsPagesWithContext(ctx aws.Context, input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool, opts ...request.Option) error

DescribeEventsPagesWithContext same as DescribeEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeEventsRequest 

func (c *Health) DescribeEventsRequest(input *DescribeEventsInput) (req *request.Request, output *DescribeEventsOutput)

DescribeEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEvents for more information on using the DescribeEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventsRequest method.
req, resp := client.DescribeEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*Health) DescribeEventsWithContext added in v1.8.0 

func (c *Health) DescribeEventsWithContext(ctx aws.Context, input *DescribeEventsInput, opts ...request.Option) (*DescribeEventsOutput, error)

DescribeEventsWithContext is the same as DescribeEvents with the addition of the ability to pass a context and additional request options.

See DescribeEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DescribeHealthServiceStatusForOrganization added in v1.26.8 

func (c *Health) DescribeHealthServiceStatusForOrganization(input *DescribeHealthServiceStatusForOrganizationInput) (*DescribeHealthServiceStatusForOrganizationOutput, error)

DescribeHealthServiceStatusForOrganization API operation for AWS Health APIs and Notifications.

This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DescribeHealthServiceStatusForOrganization for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeHealthServiceStatusForOrganization

func (*Health) DescribeHealthServiceStatusForOrganizationRequest added in v1.26.8 

func (c *Health) DescribeHealthServiceStatusForOrganizationRequest(input *DescribeHealthServiceStatusForOrganizationInput) (req *request.Request, output *DescribeHealthServiceStatusForOrganizationOutput)

DescribeHealthServiceStatusForOrganizationRequest generates a "aws/request.Request" representing the client's request for the DescribeHealthServiceStatusForOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeHealthServiceStatusForOrganization for more information on using the DescribeHealthServiceStatusForOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeHealthServiceStatusForOrganizationRequest method.
req, resp := client.DescribeHealthServiceStatusForOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeHealthServiceStatusForOrganization

func (*Health) DescribeHealthServiceStatusForOrganizationWithContext added in v1.26.8 

func (c *Health) DescribeHealthServiceStatusForOrganizationWithContext(ctx aws.Context, input *DescribeHealthServiceStatusForOrganizationInput, opts ...request.Option) (*DescribeHealthServiceStatusForOrganizationOutput, error)

DescribeHealthServiceStatusForOrganizationWithContext is the same as DescribeHealthServiceStatusForOrganization with the addition of the ability to pass a context and additional request options.

See DescribeHealthServiceStatusForOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) DisableHealthServiceAccessForOrganization added in v1.26.8 

func (c *Health) DisableHealthServiceAccessForOrganization(input *DisableHealthServiceAccessForOrganizationInput) (*DisableHealthServiceAccessForOrganizationOutput, error)

DisableHealthServiceAccessForOrganization API operation for AWS Health APIs and Notifications.

Disables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in the Health User Guide.

This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role) in the IAM User Guide.

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess (https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html) API operation. After you call this operation, Health stops aggregating events for all other Amazon Web Services accounts in your organization. If you call the Health API operations for organizational view, Health returns an error. Health continues to aggregate health events for your Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation DisableHealthServiceAccessForOrganization for usage and error information.

Returned Error Types:

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DisableHealthServiceAccessForOrganization

func (*Health) DisableHealthServiceAccessForOrganizationRequest added in v1.26.8 

func (c *Health) DisableHealthServiceAccessForOrganizationRequest(input *DisableHealthServiceAccessForOrganizationInput) (req *request.Request, output *DisableHealthServiceAccessForOrganizationOutput)

DisableHealthServiceAccessForOrganizationRequest generates a "aws/request.Request" representing the client's request for the DisableHealthServiceAccessForOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableHealthServiceAccessForOrganization for more information on using the DisableHealthServiceAccessForOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisableHealthServiceAccessForOrganizationRequest method.
req, resp := client.DisableHealthServiceAccessForOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DisableHealthServiceAccessForOrganization

func (*Health) DisableHealthServiceAccessForOrganizationWithContext added in v1.26.8 

func (c *Health) DisableHealthServiceAccessForOrganizationWithContext(ctx aws.Context, input *DisableHealthServiceAccessForOrganizationInput, opts ...request.Option) (*DisableHealthServiceAccessForOrganizationOutput, error)

DisableHealthServiceAccessForOrganizationWithContext is the same as DisableHealthServiceAccessForOrganization with the addition of the ability to pass a context and additional request options.

See DisableHealthServiceAccessForOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Health) EnableHealthServiceAccessForOrganization added in v1.26.8 

func (c *Health) EnableHealthServiceAccessForOrganization(input *EnableHealthServiceAccessForOrganizationInput) (*EnableHealthServiceAccessForOrganizationOutput, error)

EnableHealthServiceAccessForOrganization API operation for AWS Health APIs and Notifications.

Enables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.

This operation also creates a service-linked role for the management account in the organization.

To call this operation, you must meet the following requirements:

If you don't have the required support plan, you can instead use the Health console to enable the organizational view feature. For more information, see Aggregating Health events (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in the Health User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Health APIs and Notifications's API operation EnableHealthServiceAccessForOrganization for usage and error information.

Returned Error Types:

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EnableHealthServiceAccessForOrganization

func (*Health) EnableHealthServiceAccessForOrganizationRequest added in v1.26.8 

func (c *Health) EnableHealthServiceAccessForOrganizationRequest(input *EnableHealthServiceAccessForOrganizationInput) (req *request.Request, output *EnableHealthServiceAccessForOrganizationOutput)

EnableHealthServiceAccessForOrganizationRequest generates a "aws/request.Request" representing the client's request for the EnableHealthServiceAccessForOrganization operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableHealthServiceAccessForOrganization for more information on using the EnableHealthServiceAccessForOrganization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the EnableHealthServiceAccessForOrganizationRequest method.
req, resp := client.EnableHealthServiceAccessForOrganizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EnableHealthServiceAccessForOrganization

func (*Health) EnableHealthServiceAccessForOrganizationWithContext added in v1.26.8 

func (c *Health) EnableHealthServiceAccessForOrganizationWithContext(ctx aws.Context, input *EnableHealthServiceAccessForOrganizationInput, opts ...request.Option) (*EnableHealthServiceAccessForOrganizationOutput, error)

EnableHealthServiceAccessForOrganizationWithContext is the same as EnableHealthServiceAccessForOrganization with the addition of the ability to pass a context and additional request options.

See EnableHealthServiceAccessForOrganization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type InvalidPaginationToken added in v1.28.0 

type InvalidPaginationToken struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified pagination token (nextToken) is not valid.

func (*InvalidPaginationToken) Code added in v1.28.0 

func (s *InvalidPaginationToken) Code() string

Code returns the exception type name.

func (*InvalidPaginationToken) Error added in v1.28.0 

func (s *InvalidPaginationToken) Error() string

func (InvalidPaginationToken) GoString added in v1.28.0 

func (s InvalidPaginationToken) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidPaginationToken) Message added in v1.28.0 

func (s *InvalidPaginationToken) Message() string

Message returns the exception's message.

func (*InvalidPaginationToken) OrigErr added in v1.28.0 

func (s *InvalidPaginationToken) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPaginationToken) RequestID added in v1.28.0 

func (s *InvalidPaginationToken) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPaginationToken) StatusCode added in v1.28.0 

func (s *InvalidPaginationToken) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPaginationToken) String added in v1.28.0 

func (s InvalidPaginationToken) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrganizationAffectedEntitiesErrorItem added in v1.26.8 

type OrganizationAffectedEntitiesErrorItem struct {

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AwsAccountId *string `locationName:"awsAccountId" type:"string"`

	// A message that describes the error. Follow the error message and retry your
	// request.
	//
	// For example, the InvalidAccountInputError error message appears if you call
	// the DescribeAffectedEntitiesForOrganization operation and specify the AccountSpecific
	// value for the EventScopeCode parameter, but don't specify an Amazon Web Services
	// account.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

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

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// 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 DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) operation can't find or process a specific entity.

func (OrganizationAffectedEntitiesErrorItem) GoString added in v1.26.8 

func (s OrganizationAffectedEntitiesErrorItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrganizationAffectedEntitiesErrorItem) SetAwsAccountId added in v1.26.8 

func (s *OrganizationAffectedEntitiesErrorItem) SetAwsAccountId(v string) *OrganizationAffectedEntitiesErrorItem

SetAwsAccountId sets the AwsAccountId field's value.

func (*OrganizationAffectedEntitiesErrorItem) SetErrorMessage added in v1.26.8 

func (s *OrganizationAffectedEntitiesErrorItem) SetErrorMessage(v string) *OrganizationAffectedEntitiesErrorItem

SetErrorMessage sets the ErrorMessage field's value.

func (*OrganizationAffectedEntitiesErrorItem) SetErrorName added in v1.26.8 

func (s *OrganizationAffectedEntitiesErrorItem) SetErrorName(v string) *OrganizationAffectedEntitiesErrorItem

SetErrorName sets the ErrorName field's value.

func (*OrganizationAffectedEntitiesErrorItem) SetEventArn added in v1.26.8 

func (s *OrganizationAffectedEntitiesErrorItem) SetEventArn(v string) *OrganizationAffectedEntitiesErrorItem

SetEventArn sets the EventArn field's value.

func (OrganizationAffectedEntitiesErrorItem) String added in v1.26.8 

func (s OrganizationAffectedEntitiesErrorItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrganizationEvent added in v1.26.8 

type OrganizationEvent struct {

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// 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 date and time that the event ended.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// This parameter specifies if the Health event is a public Amazon Web Service
	// event or an account-specific event.
	//
	//    * If the eventScopeCode value is PUBLIC, then the affectedAccounts value
	//    is always empty.
	//
	//    * If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts
	//    value lists the affected Amazon Web Services accounts in your organization.
	//    For example, if an event affects a service such as Amazon Elastic Compute
	//    Cloud and you have Amazon Web Services accounts that use that service,
	//    those account IDs appear in the response.
	//
	//    * If the eventScopeCode value is NONE, then the eventArn that you specified
	//    in the request is invalid or doesn't exist.
	EventScopeCode *string `locationName:"eventScopeCode" type:"string" enum:"EventScopeCode"`

	// A list of event type category codes. Possible values are issue, accountNotification,
	// or scheduledChange. Currently, the investigation value isn't supported at
	// this time.
	EventTypeCategory *string `locationName:"eventTypeCategory" min:"3" type:"string" enum:"EventTypeCategory"`

	// 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 Amazon Web Services Region name of the event.
	Region *string `locationName:"region" min:"2" type:"string"`

	// The Amazon Web Service that is affected by the event, such as EC2 and 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 *string `locationName:"statusCode" type:"string" enum:"EventStatusCode"`
	// contains filtered or unexported fields
}

Summary information about an event, returned by the DescribeEventsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) operation.

func (OrganizationEvent) GoString added in v1.26.8 

func (s OrganizationEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrganizationEvent) SetArn added in v1.26.8 

func (s *OrganizationEvent) SetArn(v string) *OrganizationEvent

SetArn sets the Arn field's value.

func (*OrganizationEvent) SetEndTime added in v1.26.8 

func (s *OrganizationEvent) SetEndTime(v time.Time) *OrganizationEvent

SetEndTime sets the EndTime field's value.

func (*OrganizationEvent) SetEventScopeCode added in v1.31.1 

func (s *OrganizationEvent) SetEventScopeCode(v string) *OrganizationEvent

SetEventScopeCode sets the EventScopeCode field's value.

func (*OrganizationEvent) SetEventTypeCategory added in v1.26.8 

func (s *OrganizationEvent) SetEventTypeCategory(v string) *OrganizationEvent

SetEventTypeCategory sets the EventTypeCategory field's value.

func (*OrganizationEvent) SetEventTypeCode added in v1.26.8 

func (s *OrganizationEvent) SetEventTypeCode(v string) *OrganizationEvent

SetEventTypeCode sets the EventTypeCode field's value.

func (*OrganizationEvent) SetLastUpdatedTime added in v1.26.8 

func (s *OrganizationEvent) SetLastUpdatedTime(v time.Time) *OrganizationEvent

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*OrganizationEvent) SetRegion added in v1.26.8 

func (s *OrganizationEvent) SetRegion(v string) *OrganizationEvent

SetRegion sets the Region field's value.

func (*OrganizationEvent) SetService added in v1.26.8 

func (s *OrganizationEvent) SetService(v string) *OrganizationEvent

SetService sets the Service field's value.

func (*OrganizationEvent) SetStartTime added in v1.26.8 

func (s *OrganizationEvent) SetStartTime(v time.Time) *OrganizationEvent

SetStartTime sets the StartTime field's value.

func (*OrganizationEvent) SetStatusCode added in v1.26.8 

func (s *OrganizationEvent) SetStatusCode(v string) *OrganizationEvent

SetStatusCode sets the StatusCode field's value.

func (OrganizationEvent) String added in v1.26.8 

func (s OrganizationEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrganizationEventDetails added in v1.26.8 

type OrganizationEventDetails struct {

	// The 12-digit Amazon Web Services account numbers that contains the affected
	// entities.
	AwsAccountId *string `locationName:"awsAccountId" type:"string"`

	// Summary information about an Health event.
	//
	// Health events can be public or account-specific:
	//
	//    * Public events might be service events that are not specific to an Amazon
	//    Web Services account. For example, if there is an issue with an Amazon
	//    Web Services Region, Health provides information about the event, even
	//    if you don't use services or resources in that Region.
	//
	//    * Account-specific events are specific to either your Amazon Web Services
	//    account or an account in your organization. For example, if there's an
	//    issue with Amazon Elastic Compute Cloud in a Region that you use, Health
	//    provides information about the event and the affected resources in the
	//    account.
	//
	// You can determine if an event is public or account-specific by using the
	// eventScopeCode parameter. For more information, see eventScopeCode (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode).
	Event *Event `locationName:"event" type:"structure"`

	// The detailed description of the event. Included in the information returned
	// by the DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html)
	// operation.
	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 (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) object, an EventDescription (https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html) object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) operation.

func (OrganizationEventDetails) GoString added in v1.26.8 

func (s OrganizationEventDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrganizationEventDetails) SetAwsAccountId added in v1.26.8 

func (s *OrganizationEventDetails) SetAwsAccountId(v string) *OrganizationEventDetails

SetAwsAccountId sets the AwsAccountId field's value.

func (*OrganizationEventDetails) SetEvent added in v1.26.8 

func (s *OrganizationEventDetails) SetEvent(v *Event) *OrganizationEventDetails

SetEvent sets the Event field's value.

func (*OrganizationEventDetails) SetEventDescription added in v1.26.8 

func (s *OrganizationEventDetails) SetEventDescription(v *EventDescription) *OrganizationEventDetails

SetEventDescription sets the EventDescription field's value.

func (*OrganizationEventDetails) SetEventMetadata added in v1.26.8 

func (s *OrganizationEventDetails) SetEventMetadata(v map[string]*string) *OrganizationEventDetails

SetEventMetadata sets the EventMetadata field's value.

func (OrganizationEventDetails) String added in v1.26.8 

func (s OrganizationEventDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrganizationEventDetailsErrorItem added in v1.26.8 

type OrganizationEventDetailsErrorItem struct {

	// Error information returned when a DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html)
	// operation can't find a specified event.
	AwsAccountId *string `locationName:"awsAccountId" type:"string"`

	// A message that describes the error.
	//
	// If you call the DescribeEventDetailsForOrganization operation and receive
	// one of the following errors, follow the recommendations in the message:
	//
	//    * We couldn't find a public event that matches your request. To find an
	//    event that is account specific, you must enter an Amazon Web Services
	//    account ID in the request.
	//
	//    * We couldn't find an account specific event for the specified Amazon
	//    Web Services account. To find an event that is public, you must enter
	//    a null value for the Amazon Web Services account ID in the request.
	//
	//    * Your Amazon Web Services account doesn't include the Amazon Web Services
	//    Support plan required to use the Health API. You must have either a Business,
	//    Enterprise On-Ramp, or Enterprise Support plan.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

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

	// The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
	// format.
	//
	// For example, an event ARN might look like the following:
	//
	// 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 DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) operation can't find a specified event.

func (OrganizationEventDetailsErrorItem) GoString added in v1.26.8 

func (s OrganizationEventDetailsErrorItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrganizationEventDetailsErrorItem) SetAwsAccountId added in v1.26.8 

func (s *OrganizationEventDetailsErrorItem) SetAwsAccountId(v string) *OrganizationEventDetailsErrorItem

SetAwsAccountId sets the AwsAccountId field's value.

func (*OrganizationEventDetailsErrorItem) SetErrorMessage added in v1.26.8 

func (s *OrganizationEventDetailsErrorItem) SetErrorMessage(v string) *OrganizationEventDetailsErrorItem

SetErrorMessage sets the ErrorMessage field's value.

func (*OrganizationEventDetailsErrorItem) SetErrorName added in v1.26.8 

func (s *OrganizationEventDetailsErrorItem) SetErrorName(v string) *OrganizationEventDetailsErrorItem

SetErrorName sets the ErrorName field's value.

func (*OrganizationEventDetailsErrorItem) SetEventArn added in v1.26.8 

func (s *OrganizationEventDetailsErrorItem) SetEventArn(v string) *OrganizationEventDetailsErrorItem

SetEventArn sets the EventArn field's value.

func (OrganizationEventDetailsErrorItem) String added in v1.26.8 

func (s OrganizationEventDetailsErrorItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OrganizationEventFilter added in v1.26.8 

type OrganizationEventFilter struct {

	// A list of 12-digit Amazon Web Services account numbers that contains the
	// affected entities.
	AwsAccountIds []*string `locationName:"awsAccountIds" min:"1" type:"list"`

	// A range of dates and times that is used by the EventFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html)
	// and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html)
	// objects. If from is set and to is set: match items where the timestamp (startTime,
	// endTime, or lastUpdatedTime) is between from and to inclusive. If from is
	// set and to is not set: match items where the timestamp value is equal to
	// or after from. If from is not set and to is set: match items where the timestamp
	// value is equal to or before to.
	EndTime *DateTimeRange `locationName:"endTime" type:"structure"`

	// 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 status codes.
	EventStatusCodes []*string `locationName:"eventStatusCodes" min:"1" type:"list" enum:"EventStatusCode"`

	// A list of event type category codes. Possible values are issue, accountNotification,
	// or scheduledChange. Currently, the investigation value isn't supported at
	// this time.
	EventTypeCategories []*string `locationName:"eventTypeCategories" min:"1" type:"list" enum:"EventTypeCategory"`

	// 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 range of dates and times that is used by the EventFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html)
	// and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html)
	// objects. If from is set and to is set: match items where the timestamp (startTime,
	// endTime, or lastUpdatedTime) is between from and to inclusive. If from is
	// set and to is not set: match items where the timestamp value is equal to
	// or after from. If from is not set and to is set: match items where the timestamp
	// value is equal to or before to.
	LastUpdatedTime *DateTimeRange `locationName:"lastUpdatedTime" type:"structure"`

	// A list of Amazon Web Services Regions.
	Regions []*string `locationName:"regions" min:"1" type:"list"`

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

	// A range of dates and times that is used by the EventFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html)
	// and EntityFilter (https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html)
	// objects. If from is set and to is set: match items where the timestamp (startTime,
	// endTime, or lastUpdatedTime) is between from and to inclusive. If from is
	// set and to is not set: match items where the timestamp value is equal to
	// or after from. If from is not set and to is set: match items where the timestamp
	// value is equal to or before to.
	StartTime *DateTimeRange `locationName:"startTime" type:"structure"`
	// contains filtered or unexported fields
}

The values to filter results from the DescribeEventsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) operation.

func (OrganizationEventFilter) GoString added in v1.26.8 

func (s OrganizationEventFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrganizationEventFilter) SetAwsAccountIds added in v1.26.8 

func (s *OrganizationEventFilter) SetAwsAccountIds(v []*string) *OrganizationEventFilter

SetAwsAccountIds sets the AwsAccountIds field's value.

func (*OrganizationEventFilter) SetEndTime added in v1.26.8 

func (s *OrganizationEventFilter) SetEndTime(v *DateTimeRange) *OrganizationEventFilter

SetEndTime sets the EndTime field's value.

func (*OrganizationEventFilter) SetEntityArns added in v1.26.8 

func (s *OrganizationEventFilter) SetEntityArns(v []*string) *OrganizationEventFilter

SetEntityArns sets the EntityArns field's value.

func (*OrganizationEventFilter) SetEntityValues added in v1.26.8 

func (s *OrganizationEventFilter) SetEntityValues(v []*string) *OrganizationEventFilter

SetEntityValues sets the EntityValues field's value.

func (*OrganizationEventFilter) SetEventStatusCodes added in v1.26.8 

func (s *OrganizationEventFilter) SetEventStatusCodes(v []*string) *OrganizationEventFilter

SetEventStatusCodes sets the EventStatusCodes field's value.

func (*OrganizationEventFilter) SetEventTypeCategories added in v1.26.8 

func (s *OrganizationEventFilter) SetEventTypeCategories(v []*string) *OrganizationEventFilter

SetEventTypeCategories sets the EventTypeCategories field's value.

func (*OrganizationEventFilter) SetEventTypeCodes added in v1.26.8 

func (s *OrganizationEventFilter) SetEventTypeCodes(v []*string) *OrganizationEventFilter

SetEventTypeCodes sets the EventTypeCodes field's value.

func (*OrganizationEventFilter) SetLastUpdatedTime added in v1.26.8 

func (s *OrganizationEventFilter) SetLastUpdatedTime(v *DateTimeRange) *OrganizationEventFilter

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*OrganizationEventFilter) SetRegions added in v1.26.8 

func (s *OrganizationEventFilter) SetRegions(v []*string) *OrganizationEventFilter

SetRegions sets the Regions field's value.

func (*OrganizationEventFilter) SetServices added in v1.26.8 

func (s *OrganizationEventFilter) SetServices(v []*string) *OrganizationEventFilter

SetServices sets the Services field's value.

func (*OrganizationEventFilter) SetStartTime added in v1.26.8 

func (s *OrganizationEventFilter) SetStartTime(v *DateTimeRange) *OrganizationEventFilter

SetStartTime sets the StartTime field's value.

func (OrganizationEventFilter) String added in v1.26.8 

func (s OrganizationEventFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OrganizationEventFilter) Validate added in v1.26.8 

func (s *OrganizationEventFilter) Validate() error

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

type UnsupportedLocale added in v1.28.0 

type UnsupportedLocale struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified locale is not supported.

func (*UnsupportedLocale) Code added in v1.28.0 

func (s *UnsupportedLocale) Code() string

Code returns the exception type name.

func (*UnsupportedLocale) Error added in v1.28.0 

func (s *UnsupportedLocale) Error() string

func (UnsupportedLocale) GoString added in v1.28.0 

func (s UnsupportedLocale) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedLocale) Message added in v1.28.0 

func (s *UnsupportedLocale) Message() string

Message returns the exception's message.

func (*UnsupportedLocale) OrigErr added in v1.28.0 

func (s *UnsupportedLocale) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedLocale) RequestID added in v1.28.0 

func (s *UnsupportedLocale) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedLocale) StatusCode added in v1.28.0 

func (s *UnsupportedLocale) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedLocale) String added in v1.28.0 

func (s UnsupportedLocale) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.