Class ListEnvironmentsRequest

    • Method Detail

      • awsAccountId

        public final String awsAccountId()

        The identifier of the Amazon Web Services account where you want to list environments.

        Returns:
        The identifier of the Amazon Web Services account where you want to list environments.
      • awsAccountRegion

        public final String awsAccountRegion()

        The Amazon Web Services region where you want to list environments.

        Returns:
        The Amazon Web Services region where you want to list environments.
      • domainIdentifier

        public final String domainIdentifier()

        The identifier of the Amazon DataZone domain.

        Returns:
        The identifier of the Amazon DataZone domain.
      • environmentBlueprintIdentifier

        public final String environmentBlueprintIdentifier()

        The identifier of the Amazon DataZone blueprint.

        Returns:
        The identifier of the Amazon DataZone blueprint.
      • environmentProfileIdentifier

        public final String environmentProfileIdentifier()

        The identifier of the environment profile.

        Returns:
        The identifier of the environment profile.
      • maxResults

        public final Integer maxResults()

        The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.

        Returns:
        The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.
      • name

        public final String name()

        The name of the environment.

        Returns:
        The name of the environment.
      • nextToken

        public final String nextToken()

        When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

        Returns:
        When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.
      • projectIdentifier

        public final String projectIdentifier()

        The identifier of the Amazon DataZone project.

        Returns:
        The identifier of the Amazon DataZone project.
      • provider

        public final String provider()

        The provider of the environment.

        Returns:
        The provider of the environment.
      • statusAsString

        public final String statusAsString()

        The status of the environments that you want to list.

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

        Returns:
        The status of the environments that you want to list.
        See Also:
        EnvironmentStatus
      • 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