Interface OrganizationEventDetailsErrorItem.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<OrganizationEventDetailsErrorItem.Builder,OrganizationEventDetailsErrorItem>,SdkBuilder<OrganizationEventDetailsErrorItem.Builder,OrganizationEventDetailsErrorItem>,SdkPojo
- Enclosing class:
- OrganizationEventDetailsErrorItem
public static interface OrganizationEventDetailsErrorItem.Builder extends SdkPojo, CopyableBuilder<OrganizationEventDetailsErrorItem.Builder,OrganizationEventDetailsErrorItem>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description OrganizationEventDetailsErrorItem.BuilderawsAccountId(String awsAccountId)Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.OrganizationEventDetailsErrorItem.BuildererrorMessage(String errorMessage)A message that describes the error.OrganizationEventDetailsErrorItem.BuildererrorName(String errorName)The name of the error.OrganizationEventDetailsErrorItem.BuildereventArn(String eventArn)The unique identifier for the event.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
awsAccountId
OrganizationEventDetailsErrorItem.Builder awsAccountId(String awsAccountId)
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
- Parameters:
awsAccountId- Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventArn
OrganizationEventDetailsErrorItem.Builder eventArn(String eventArn)
The unique identifier for the event. The event ARN has the
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_IDformat.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- Parameters:
eventArn- The unique identifier for the event. The event ARN has thearn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_IDformat.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:
- Returns a reference to this object so that method calls can be chained together.
-
errorName
OrganizationEventDetailsErrorItem.Builder errorName(String errorName)
The name of the error.
- Parameters:
errorName- The name of the error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorMessage
OrganizationEventDetailsErrorItem.Builder errorMessage(String errorMessage)
A message that describes the error.
If you call the
DescribeEventDetailsForOrganizationoperation and receive one of the following errors, follow the recommendations in the message:-
We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.
-
We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.
-
Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.
- Parameters:
errorMessage- A message that describes the error.If you call the
DescribeEventDetailsForOrganizationoperation and receive one of the following errors, follow the recommendations in the message:-
We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.
-
We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.
-
Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
-