Package software.amazon.awssdk.services.ssm.model

Class DescribeParametersRequest

    • Method Detail

      • hasFilters

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

      • filters

        public final List<ParametersFilter> filters()

        This data type is deprecated. Instead, use ParameterFilters.

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

        Returns:
        This data type is deprecated. Instead, use ParameterFilters.

      • hasParameterFilters

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

      • parameterFilters

        public final List<ParameterStringFilter> parameterFilters()

        Filters to limit the request results.

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

        Returns:
        Filters to limit the request results.

      • maxResults

        public final Integer maxResults()

        The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

        Returns:
        The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

      • nextToken

        public final String nextToken()

        The token for the next set of items to return. (You received this token from a previous call.)

        Returns:
        The token for the next set of items to return. (You received this token from a previous call.)

      • shared

        public final Boolean shared()

        Lists parameters that are shared with you.

        By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

        For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

        Returns:
        Lists parameters that are shared with you.

        By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

        For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

      • 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