Amp
This page documents function available when using the Amp
module, created with @service Amp
.
Index
Main.Amp.create_workspace
Main.Amp.delete_workspace
Main.Amp.describe_workspace
Main.Amp.list_workspaces
Main.Amp.update_workspace_alias
Documentation
Main.Amp.create_workspace
— Methodcreate_workspace()
create_workspace(params::Dict{String,<:Any})
Creates a new AMP workspace.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"alias"
: An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique."clientToken"
: Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.delete_workspace
— Methoddelete_workspace(workspace_id)
delete_workspace(workspace_id, params::Dict{String,<:Any})
Deletes an AMP workspace.
Arguments
workspace_id
: The ID of the workspace to delete.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"clientToken"
: Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.describe_workspace
— Methoddescribe_workspace(workspace_id)
describe_workspace(workspace_id, params::Dict{String,<:Any})
Describes an existing AMP workspace.
Arguments
workspace_id
: The ID of the workspace to describe.
Main.Amp.list_workspaces
— Methodlist_workspaces()
list_workspaces(params::Dict{String,<:Any})
Lists all AMP workspaces, including workspaces being created or deleted.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"alias"
: Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned."maxResults"
: Maximum results to return in response (default=100, maximum=1000)."nextToken"
: Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
Main.Amp.update_workspace_alias
— Methodupdate_workspace_alias(workspace_id)
update_workspace_alias(workspace_id, params::Dict{String,<:Any})
Updates an AMP workspace alias.
Arguments
workspace_id
: The ID of the workspace being updated.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"alias"
: The new alias of the workspace."clientToken"
: Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.