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(value="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 and Description
static interface	OrganizationEvent.Builder

Method Summary

Modifier and Type	Method and 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 AWS Health event is a public AWS service event or an account-specific event.
String	eventScopeCodeAsString() This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.
EventTypeCategory	eventTypeCategory() The category of the event type.
String	eventTypeCategoryAsString() The category of the event type.
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 AWS Region name of the event.
List<SdkField<?>>	sdkFields()
static Class<? extends OrganizationEvent.Builder>	serializableBuilderClass()
String	service() The AWS service that is affected by the event.
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 String arn()

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

Returns:

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

service

public String service()

The AWS service that is affected by the event. For example, EC2, RDS.

Returns:

The AWS service that is affected by the event. For example, EC2, RDS.

eventTypeCode

public 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 EventTypeCategory eventTypeCategory()

The category of the event type.

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:

The category of the event type.

See Also:

EventTypeCategory

eventTypeCategoryAsString

public String eventTypeCategoryAsString()

The category of the event type.

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:

The category of the event type.

See Also:

EventTypeCategory

eventScopeCode

public EventScopeCode eventScopeCode()

This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS 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 AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS 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 String eventScopeCodeAsString()

This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS 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 AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS 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 String region()

The AWS Region name of the event.

Returns:

The AWS Region name of the event.

startTime

public Instant startTime()

The date and time that the event began.

Returns:

The date and time that the event began.

endTime

public Instant endTime()

The date and time that the event ended.

Returns:

The date and time that the event ended.

lastUpdatedTime

public 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 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo