Class DescribeExportResponse

    • Method Detail

      • exportId

        public final String exportId()

        The unique identifier of the described export.

        Returns:
        The unique identifier of the described export.
      • resourceSpecification

        public final ExportResourceSpecification resourceSpecification()

        The bot, bot ID, and optional locale ID of the exported bot or bot locale.

        Returns:
        The bot, bot ID, and optional locale ID of the exported bot or bot locale.
      • exportStatus

        public final ExportStatus exportStatus()

        The status of the export. When the status is Complete the export archive file is available for download.

        If the service returns an enum value that is not available in the current SDK version, exportStatus will return ExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportStatusAsString().

        Returns:
        The status of the export. When the status is Complete the export archive file is available for download.
        See Also:
        ExportStatus
      • exportStatusAsString

        public final String exportStatusAsString()

        The status of the export. When the status is Complete the export archive file is available for download.

        If the service returns an enum value that is not available in the current SDK version, exportStatus will return ExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportStatusAsString().

        Returns:
        The status of the export. When the status is Complete the export archive file is available for download.
        See Also:
        ExportStatus
      • hasFailureReasons

        public final boolean hasFailureReasons()
        For responses, this returns true if the service returned a value for the FailureReasons 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.
      • failureReasons

        public final List<String> failureReasons()

        If the exportStatus is failed, contains one or more reasons why the export could not be completed.

        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 hasFailureReasons() method.

        Returns:
        If the exportStatus is failed, contains one or more reasons why the export could not be completed.
      • downloadUrl

        public final String downloadUrl()

        A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.

        Returns:
        A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.
      • creationDateTime

        public final Instant creationDateTime()

        The date and time that the export was created.

        Returns:
        The date and time that the export was created.
      • lastUpdatedDateTime

        public final Instant lastUpdatedDateTime()

        The last date and time that the export was updated.

        Returns:
        The last date and time that the export was updated.
      • 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