Package software.amazon.awssdk.services.health.model

Class OrganizationEvent

java.lang.Object

software.amazon.awssdk.services.health.model.OrganizationEvent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrganizationEvent.Builder,OrganizationEvent>

@Generated("software.amazon.awssdk:codegen")
public final class OrganizationEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationEvent.Builder,OrganizationEvent>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OrganizationEvent.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The unique identifier for the event.
static OrganizationEvent.Builder	builder()
Instant	endTime()	The date and time that the event ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventScopeCode	eventScopeCode()	This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.
String	eventScopeCodeAsString()	This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.
EventTypeCategory	eventTypeCategory()	A list of event type category codes.
String	eventTypeCategoryAsString()	A list of event type category codes.
String	eventTypeCode()	The unique identifier for the event type.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTime()	The most recent date and time that the event was updated.
String	region()	The Amazon Web Services Region name of the event.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OrganizationEvent.Builder>	serializableBuilderClass()
String	service()	The Amazon Web Services service that is affected by the event, such as EC2 and RDS.
Instant	startTime()	The date and time that the event began.
EventStatusCode	statusCode()	The most recent status of the event.
String	statusCodeAsString()	The most recent status of the event.
OrganizationEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

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

Returns:

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

service

public final String service()

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

Returns:

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

eventTypeCode

public final String eventTypeCode()

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

Returns:

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

eventTypeCategory

public final EventTypeCategory eventTypeCategory()

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

If the service returns an enum value that is not available in the current SDK version, eventTypeCategory will return EventTypeCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeCategoryAsString().

Returns:

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

See Also:

EventTypeCategory

eventTypeCategoryAsString

public final String eventTypeCategoryAsString()

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

If the service returns an enum value that is not available in the current SDK version, eventTypeCategory will return EventTypeCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeCategoryAsString().

Returns:

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

See Also:

EventTypeCategory

eventScopeCode

public final EventScopeCode eventScopeCode()

This parameter specifies if the Health event is a public Amazon Web Services 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.

If the service returns an enum value that is not available in the current SDK version, eventScopeCode will return EventScopeCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventScopeCodeAsString().

Returns:

This parameter specifies if the Health event is a public Amazon Web Services 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.

See Also:

EventScopeCode

eventScopeCodeAsString

public final String eventScopeCodeAsString()

This parameter specifies if the Health event is a public Amazon Web Services 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.

If the service returns an enum value that is not available in the current SDK version, eventScopeCode will return EventScopeCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventScopeCodeAsString().

Returns:

This parameter specifies if the Health event is a public Amazon Web Services 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.

See Also:

EventScopeCode

region

public final String region()

The Amazon Web Services Region name of the event.

Returns:

The Amazon Web Services Region name of the event.

startTime

public final Instant startTime()

The date and time that the event began.

Returns:

The date and time that the event began.

endTime

public final Instant endTime()

The date and time that the event ended.

Returns:

The date and time that the event ended.

lastUpdatedTime

public final Instant lastUpdatedTime()

The most recent date and time that the event was updated.

Returns:

The most recent date and time that the event was updated.

statusCode

public final EventStatusCode statusCode()

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

If the service returns an enum value that is not available in the current SDK version, statusCode() will return EventStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

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

See Also:

EventStatusCode

statusCodeAsString

public final String statusCodeAsString()

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

If the service returns an enum value that is not available in the current SDK version, statusCode() will return EventStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

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

See Also:

EventStatusCode

toBuilder

public OrganizationEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OrganizationEvent.Builder,OrganizationEvent>

builder

public static OrganizationEvent.Builder builder()

serializableBuilderClass

public static Class<? extends OrganizationEvent.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo