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) Indicates whether some other object is "equal to" this one by SDK fields.
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasAffectedAccounts() Returns true if the AffectedAccounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasAffectedAccounts

public final boolean hasAffectedAccounts()

Returns true if the AffectedAccounts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasAffectedAccounts() to see if a value was sent in this field.

Returns:

A JSON set of elements of the affected accounts.

eventScopeCode

public final 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 final 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

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()

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 interface ToCopyableBuilder<DescribeAffectedAccountsForOrganizationResponse.Builder,DescribeAffectedAccountsForOrganizationResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.