Package software.amazon.awssdk.services.cloudtrail.model

Class GetTrailStatusResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse
software.amazon.awssdk.services.cloudtrail.model.GetTrailStatusResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTrailStatusResponse.Builder,GetTrailStatusResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetTrailStatusResponse extends CloudTrailResponse implements ToCopyableBuilder<GetTrailStatusResponse.Builder,GetTrailStatusResponse>

Returns the objects or data listed below if successful. Otherwise, returns an error.

  • Method Details

    • isLogging

      public final Boolean isLogging()

      Whether the CloudTrail trail is currently logging Amazon Web Services API calls.

      Returns:
      Whether the CloudTrail trail is currently logging Amazon Web Services API calls.

    • latestDeliveryError

      public final String latestDeliveryError()

      Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

      This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

      Returns:
      Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

      This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

    • latestNotificationError

      public final String latestNotificationError()

      Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.

      Returns:
      Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.

    • latestDeliveryTime

      public final Instant latestDeliveryTime()

      Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

      Returns:
      Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

    • latestNotificationTime

      public final Instant latestNotificationTime()

      Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

      Returns:
      Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

    • startLoggingTime

      public final Instant startLoggingTime()

      Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.

      Returns:
      Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.

    • stopLoggingTime

      public final Instant stopLoggingTime()

      Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.

      Returns:
      Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.

    • latestCloudWatchLogsDeliveryError

      public final String latestCloudWatchLogsDeliveryError()

      Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

      Returns:
      Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

    • latestCloudWatchLogsDeliveryTime

      public final Instant latestCloudWatchLogsDeliveryTime()

      Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

      Returns:
      Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

    • latestDigestDeliveryTime

      public final Instant latestDigestDeliveryTime()

      Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

      Returns:
      Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

    • latestDigestDeliveryError

      public final String latestDigestDeliveryError()

      Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

      This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

      Returns:
      Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

      This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

    • latestDeliveryAttemptTime

      public final String latestDeliveryAttemptTime()

      This field is no longer in use.

      Returns:
      This field is no longer in use.

    • latestNotificationAttemptTime

      public final String latestNotificationAttemptTime()

      This field is no longer in use.

      Returns:
      This field is no longer in use.

    • latestNotificationAttemptSucceeded

      public final String latestNotificationAttemptSucceeded()

      This field is no longer in use.

      Returns:
      This field is no longer in use.

    • latestDeliveryAttemptSucceeded

      public final String latestDeliveryAttemptSucceeded()

      This field is no longer in use.

      Returns:
      This field is no longer in use.

    • timeLoggingStarted

      public final String timeLoggingStarted()

      This field is no longer in use.

      Returns:
      This field is no longer in use.

    • timeLoggingStopped

      public final String timeLoggingStopped()

      This field is no longer in use.

      Returns:
      This field is no longer in use.

    • toBuilder

      public GetTrailStatusResponse.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<GetTrailStatusResponse.Builder,GetTrailStatusResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetTrailStatusResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTrailStatusResponse.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.