Class OrganizationEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OrganizationEvent.Builder,
OrganizationEvent>
Summary information about an event, returned by the DescribeEventsForOrganization operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The unique identifier for the event.static OrganizationEvent.Builder
builder()
final Instant
endTime()
The date and time that the event ended.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EventScopeCode
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.final String
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.final EventTypeCategory
A list of event type category codes.final String
A list of event type category codes.final String
The unique identifier for the event type.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The most recent date and time that the event was updated.final String
region()
The Amazon Web Services Region name of the event.static Class
<? extends OrganizationEvent.Builder> final String
service()
The Amazon Web Service that is affected by the event, such as EC2 and RDS.final Instant
The date and time that the event began.final EventStatusCode
The most recent status of the event.final String
The most recent status of the event.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Web Service that is affected by the event, such as EC2 and RDS.
- Returns:
- The Amazon Web Service that is affected by the event, such as EC2 and RDS.
-
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
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
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 returnEventTypeCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventTypeCategoryAsString()
.- Returns:
- A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - See Also:
-
eventTypeCategoryAsString
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
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 returnEventTypeCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventTypeCategoryAsString()
.- Returns:
- A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - See Also:
-
eventScopeCode
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.
-
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
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 returnEventScopeCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventScopeCodeAsString()
.- Returns:
- This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific
event.
-
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
-
- See Also:
-
-
eventScopeCodeAsString
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.
-
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
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 returnEventScopeCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventScopeCodeAsString()
.- Returns:
- This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific
event.
-
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
-
- See Also:
-
-
region
The Amazon Web Services Region name of the event.
- Returns:
- The Amazon Web Services Region name of the event.
-
startTime
The date and time that the event began.
- Returns:
- The date and time that the event began.
-
endTime
The date and time that the event ended.
- Returns:
- The date and time that the event ended.
-
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
The most recent status of the event. Possible values are
open
,closed
, andupcoming
.If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnEventStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The most recent status of the event. Possible values are
open
,closed
, andupcoming
. - See Also:
-
statusCodeAsString
The most recent status of the event. Possible values are
open
,closed
, andupcoming
.If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnEventStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The most recent status of the event. Possible values are
open
,closed
, andupcoming
. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<OrganizationEvent.Builder,
OrganizationEvent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-