ExAws.SSM

v2.1.0

ExAws.SSM v2.1.0 ExAws.SSM View Source

Documentation for ExAws.SSM.

AWS API version 2014-11-06.

Link to this section Summary

Types

decryption_opt()
get_parameter_history_opt()
get_parameter_opt()
get_parameters_by_path_opt()
pagination_opts()
parameter_filters()
parameter_value_type()
put_parameter_opt()

Functions

delete_parameter(name)

Delete a parameter from the system

delete_parameters(names)

Delete a list of parameters

get_parameter(name, opts \\ [])

Get information about a parameter by using the parameter name

get_parameter_history(name, opts \\ [])

Query a list of all parameters used by the AWS account

get_parameters(names, opts \\ [])

Get details of a parameter

get_parameters_by_path(path, opts \\ [])

Retrieve parameters in a specific hierarchy

put_parameter(name, type, value, opts \\ [])

Add a parameter to the system

Link to this section Types

Link to this type decryption_opt() View Source 
decryption_opt() :: {:with_decryption, boolean()}
Link to this type get_parameter_history_opt() View Source 
get_parameter_history_opt() ::
  {:name, binary()} | pagination_opts() | decryption_opt()
Link to this type get_parameter_opt() View Source 
get_parameter_opt() :: decryption_opt()
Link to this type get_parameters_by_path_opt() View Source 
get_parameters_by_path_opt() ::
  {:recursive, boolean()}
  | {:parameter_filters, [parameter_filters()]}
  | pagination_opts()
  | decryption_opt()
Link to this type pagination_opts() View Source 
pagination_opts() :: {:max_results, pos_integer()} | {:next_token, binary()}
Link to this type parameter_filters() View Source 
parameter_filters() :: [key: binary(), option: binary(), values: [binary()]]
Link to this type parameter_value_type() View Source 
parameter_value_type() :: :string | :string_list | :secure_string
Link to this type put_parameter_opt() View Source 
put_parameter_opt() ::
  {:allowed_pattern, binary()}
  | {:description, binary()}
  | {:key_id, binary()}
  | {:overwrite, boolean()}

Link to this section Functions

Link to this function delete_parameter(name) View Source 
delete_parameter(name :: binary()) :: ExAws.Operation.JSON.t()

Delete a parameter from the system.

Link to this function delete_parameters(names) View Source 
delete_parameters(names :: [binary()]) :: ExAws.Operation.JSON.t()

Delete a list of parameters.

Link to this function get_parameter(name, opts \\ []) View Source 
get_parameter(name :: binary(), opts :: [get_parameter_opt()]) ::
  ExAws.Operation.JSON.t()

Get information about a parameter by using the parameter name.

Link to this function get_parameter_history(name, opts \\ []) View Source 
get_parameter_history(name :: binary(), opts :: [get_parameter_history_opt()]) ::
  ExAws.Operation.JSON.t()

Query a list of all parameters used by the AWS account.

Link to this function get_parameters(names, opts \\ []) View Source 
get_parameters(names :: [binary()], opts :: [get_parameter_opt()]) ::
  ExAws.Operation.JSON.t()

Get details of a parameter

Link to this function get_parameters_by_path(path, opts \\ []) View Source 
get_parameters_by_path(path :: binary(), opts :: [get_parameters_by_path_opt()]) ::
  ExAws.Operation.JSON.t()

Retrieve parameters in a specific hierarchy.

Link to this function put_parameter(name, type, value, opts \\ []) View Source 
put_parameter(
  name :: binary(),
  type :: parameter_value_type(),
  value :: binary(),
  opts :: [put_parameter_opt()]
) :: ExAws.Operation.JSON.t()

Add a parameter to the system.