ExAws.IAM v0.1.1 ExAws.Iam View Source
Generates ExAws operations for making IAM API requests.
You can use the low-level operation/2
to create any operation.
iex> ExAws.Iam.operation(:list_users, max_items: 50, path: "/my/path/")
%ExAws.Operation.Query{
action: "ListUsers",
params: %{
"Action" => "ListUsers",
"MaxItems" => 50,
"Path" => "/my/path/",
"Version" => "2010-05-08"
},
parser: &ExAws.Iam.Parser.parse/2,
path: "/my/path/",
service: :iam
}
You can also use one of the higher-level convenience functions.
iex> ExAws.Iam.list_users(max_items: 50, path: "/my/path/")
%ExAws.Operation.Query{
action: "ListUsers",
params: %{
"Action" => "ListUsers",
"MaxItems" => 50,
"Path" => "/my/path/",
"Version" => "2010-05-08"
},
parser: &ExAws.Iam.Parser.parse/2,
path: "/my/path/",
service: :iam
}
Parsers are currently implemented for the following actions:
- CreateAccessKey
- CreateGroup
- CreateUser
- DeleteAccessKey
- DeleteGroup
- DeleteUser
- GetAccessKeyLastUsed
- GetGroup
- GetUser
- ListAccessKeys
- ListGroup
- ListUsers
- UpdateAccessKey
- UpdateGroup
- UpdateUser
For more information on individual actions, see the AWS IAM API documentation.
- https://docs.aws.amazon.com/IAM/latest/APIReference/API_{OpName}.html
Replace OpName
with the name of the operation you want to consult.
Shared Options
:version
- The API version that the request is written for, expressed in the format YYYY-MM-DD. Defaults to2010-05-08
.:parser
- A function to parse the request. Defaults toParser.parse/2
.
Link to this section Summary
Functions
Creates an ExAws operation for a CreateAccessKey
IAM request
Creates an ExAws operation for a CreateGroup
IAM request
Creates an ExAws operation for a CreateUser
IAM request
Creates an ExAws operation for a DeleteAccessKey
IAM request
Creates an ExAws operation for a DeleteGroup
IAM request
Creates an ExAws operation for a DeleteUser
IAM request
Creates an ExAws operation for a GetAccessKeyLastUsed
IAM request
Creates an ExAws operation for a GetGroup
IAM request
Creates an ExAws operation for a GetUser
IAM request
Creates an ExAws operation for a ListAccessKeys
IAM request
Creates an ExAws operation for a ListGroups
IAM request
Creates an ExAws operation for a ListUsers
IAM request
Generates an ExAws operation for the given IAM API action. See the AWS IAM API Reference for a list of available actions and their parameters
Converts a parsed IAM response into an AccessKey
struct
Converts a parsed IAM response into a User
struct
Creates an ExAws operation for an UpdateAccessKey
IAM request
Creates an ExAws operation for an UpdateGroup
IAM request
Creates an ExAws operation for an UpdateUser
IAM request
Link to this section Functions
Creates an ExAws operation for a CreateAccessKey
IAM request.
Parameters
username
- The name of the IAM user that the new key will belong to.
Options
See shared options in moduledoc.
Creates an ExAws operation for a CreateGroup
IAM request.
Parameters
name
- The name of the IAM group to create.
Options
:path
- The path to the group. Defaults to “/“.
See shared options in moduledoc.
Creates an ExAws operation for a CreateUser
IAM request.
Parameters
username
- The name of the user to create. Must match[w+=,.@-]+
.
Options
:path
- The path for the user name. See IAM Identifiers in the IAM User Guide.:permissions_boundary
- The ARN of the policy that is used to set the permissions boundary for the user.
See shared options in moduledoc.
Creates an ExAws operation for a DeleteAccessKey
IAM request.
Parameters
access_key_id
- The access key ID you want to delete.username
- The name of the user whose access key pair you want to delete.
Options
See shared options in moduledoc.
Creates an ExAws operation for a DeleteGroup
IAM request.
Parameters
name
- The name of the group to delete.
Options
See shared options in moduledoc.
Creates an ExAws operation for a DeleteUser
IAM request.
Parameters
username
- The name of the user to delete.
Options
See shared options in moduledoc.
Creates an ExAws operation for a GetAccessKeyLastUsed
IAM request.
Parameters
access_key_id
- The identifier of the access key you want to query.
Options
See shared options in moduledoc.
Creates an ExAws operation for a GetGroup
IAM request.
Parameters
name
- The name of the group to return.
Options
See shared options in moduledoc.
Creates an ExAws operation for a GetUser
IAM request.
Parameters
username
- The name of the user to return.
Options
See shared options in moduledoc.
Creates an ExAws operation for a ListAccessKeys
IAM request.
Options
:marker
- Use this parameter only when paginating results.:max_items
- Use this only when paginating results to indicate the maximum number of items you want in the response.:user_name
- Use this parameter to limit the results to the given username.
See shared options in moduledoc.
Creates an ExAws operation for a ListGroups
IAM request.
Options
:marker
- Use this parameter only when paginating results.:max_items
- Use this only when paginating results to indicate the maximum number of items you want in the response.:path_prefix
- The path prefix for filtering the results.
See shared options in moduledoc.
Creates an ExAws operation for a ListUsers
IAM request.
Options
:marker
- Use this parameter only when paginating results.:max_items
- Use this only when paginating results to indicate the maximum number of items you want in the response.:path_prefix
- The path prefix for filtering the results.
See shared options in moduledoc.
Generates an ExAws operation for the given IAM API action. See the AWS IAM API Reference for a list of available actions and their parameters.
- https://docs.aws.amazon.com/IAM/latest/APIReference
Parameters
action
- The name of the action you want to call. Should be a CamelCase string.params
- A keyword list of any params the action accepts.
Options
parser
- A function to parse the request result. Defaults toParser.parser/2
.
See shared options in moduledoc.
Converts a parsed IAM response into an AccessKey
struct.
resp
- The parsed response of an IAM API query request.
Converts a parsed IAM response into a User
struct.
Parameters
resp
- The parsed response of an IAM API query request.
Creates an ExAws operation for an UpdateAccessKey
IAM request.
Parameters
access_key_id
- The access key ID you want to update.status
- The status you want to assign to the secret access key. Can beActive
orInactive
.
Options
:user_name
- The name of the user whose access key pair you want to update.
See shared options in moduledoc.
Creates an ExAws operation for an UpdateGroup
IAM request.
Parameters
name
- The name of the group to update. If you’re changing the name of the group, this is the original group name.
Options
:new_path
- New path for the IAM group. Include this parameter only if you’re changing the group’s path.:new_group_name
- New name for the group. Include this parameter only if you’re changing the group’s name.
See shared options in moduledoc.
Creates an ExAws operation for an UpdateUser
IAM request.
Parameters
username
- The name of the user to update. If you’re changing the name of the user, this is the original user name.
Options
:new_path
- New path for the IAM user. Include this parameter only if you’re changing the user’s path.:new_user_name
- New name for the user. Include this parameter only if you’re changing the user’s name.
See shared options in moduledoc.