software.amazon.awssdk.services.health.model

Class DescribeAffectedAccountsForOrganizationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.health.model.HealthResponse

software.amazon.awssdk.services.health.model.DescribeAffectedAccountsForOrganizationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAffectedAccountsForOrganizationResponse.Builder,DescribeAffectedAccountsForOrganizationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeAffectedAccountsForOrganizationResponse
extends HealthResponse
implements ToCopyableBuilder<DescribeAffectedAccountsForOrganizationResponse.Builder,DescribeAffectedAccountsForOrganizationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAffectedAccountsForOrganizationResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	affectedAccounts() A JSON set of elements of the affected accounts.
static DescribeAffectedAccountsForOrganizationResponse.Builder	builder()
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAffectedAccounts() For responses, this returns true if the service returned a value for the AffectedAccounts property.
int	hashCode()
String	nextToken() 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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAffectedAccountsForOrganizationResponse.Builder>	serializableBuilderClass()
DescribeAffectedAccountsForOrganizationResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.health.model.HealthResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasAffectedAccounts

public final boolean hasAffectedAccounts()

For responses, this returns true if the service returned a value for the AffectedAccounts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

affectedAccounts

public final List<String> affectedAccounts()

A JSON set of elements of the affected accounts.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAffectedAccounts() method.

Returns:

A JSON set of elements of the affected accounts.

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

nextToken

public final String nextToken()

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.

Returns:

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.

toBuilder

public DescribeAffectedAccountsForOrganizationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAffectedAccountsForOrganizationResponse.Builder,DescribeAffectedAccountsForOrganizationResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeAffectedAccountsForOrganizationResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo