en-US/AWS-Utils-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AWSVariables</command:name> <command:verb>Remove</command:verb> <command:noun>AWSVariables</command:noun> <maml:description> <maml:para>Remove selected or all AWS profile and session related environment variables.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove selected or all AWS profile and session related environment variables. The following variables are removable: $Env:AWS_PROFILE $Env:AWS_ACCESS_KEY_ID $Env:AWS_SECRET_ACCESS_KEY $Env:AWS_SESSION_TOKEN $Env:AWS_REGION $Env:AWS_ROLE_ARN $Env:AWS_ROLE_SESSION_NAME</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AWSVariables</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="A"> <maml:name>All</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_PROFILE $Env:AWS_ACCESS_KEY_ID $Env:AWS_SECRET_ACCESS_KEY $Env:AWS_SESSION_TOKEN $Env:AWS_REGION $Env:AWS_ROLE_ARN $Env:AWS_ROLE_SESSION_NAME</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AWSVariables</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="K"> <maml:name>Keys</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_ACCESS_KEY_ID $Env:AWS_SECRET_ACCESS_KEY $Env:AWS_SESSION_TOKEN</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="P"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_PROFILE</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RE"> <maml:name>Region</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_REGION</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RO"> <maml:name>Role</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_ROLE_ARN $Env:AWS_ROLE_SESSION_NAME</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="A"> <maml:name>All</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_PROFILE $Env:AWS_ACCESS_KEY_ID $Env:AWS_SECRET_ACCESS_KEY $Env:AWS_SESSION_TOKEN $Env:AWS_REGION $Env:AWS_ROLE_ARN $Env:AWS_ROLE_SESSION_NAME</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="K"> <maml:name>Keys</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_ACCESS_KEY_ID $Env:AWS_SECRET_ACCESS_KEY $Env:AWS_SESSION_TOKEN</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="P"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_PROFILE</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RE"> <maml:name>Region</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_REGION</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RO"> <maml:name>Role</maml:name> <maml:description> <maml:para>Removes all of the following AWS envrionment variables: $Env:AWS_ROLE_ARN $Env:AWS_ROLE_SESSION_NAME</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>awc -A Removes all AWS related environment variables.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>awc -K Removes the Env:AWS_ACCESS_KEY_ID, $Env:AWS_SECRET_ACCESS_KEY and $Env:AWS_SESSION_TOKEN environment variables.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>awc -P Removes the $Env:AWS_PROFILE environment variable.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>awc -RE Removes the $Env:AWS_REGION environment variable.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>awc -RO Removes the $Env:AWS_ROLE_ARN and $Env:AWS_ROLE_SESSION_NAME environment variables.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>awc -P -K Removes the $Env:AWS_PROFILE, Env:AWS_ACCESS_KEY_ID, $Env:AWS_SECRET_ACCESS_KEY and $Env:AWS_SESSION_TOKEN environment variables.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AWSProfile</command:name> <command:verb>Set</command:verb> <command:noun>AWSProfile</command:noun> <maml:description> <maml:para>Set current shell session AWS Profile via environment variable.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of your configured AWS Profiles through the AWS CLI. Select a profile from the list using FZF and finally export that profile to the $env:AWS_PROFILE environment variable. This variable is respected by the AWS CLI, see Configuration settings and precedence in the AWS CLI documentation: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AWSProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Name"> <maml:name>Profile</maml:name> <maml:description> <maml:para>{{ Fill Profile Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Name"> <maml:name>Profile</maml:name> <maml:description> <maml:para>{{ Fill Profile Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>ProfileName</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>awp List all profiles in your .aws/config file for interactive selection. Selected profile exported to $env:AWS_PROFILE environment variable</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>awp myprofile Pre-sort the profile list with the entered keyword. If multiple profiles matches the keyword, user is prompted to select profile from a list. If only a single match is found that profile is directly selected without further user prompts. Selected profile exported to $env:AWS_PROFILE environment variable</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AWSRegion</command:name> <command:verb>Set</command:verb> <command:noun>AWSRegion</command:noun> <maml:description> <maml:para>Set default region to use for current shell session via environment variable.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of allowed AWS Regions for your account through the AWS CLI. Select a region from the list using FZF and finally export that profile to the $env:AWS_REGION environment variable.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AWSRegion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Region</maml:name> <maml:description> <maml:para>{{ Fill Region Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Region</maml:name> <maml:description> <maml:para>{{ Fill Region Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Region</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>awr List all allowed regions in your AWS account for interactive selection. Selected region is exported to $env:AWS_REGION environment variable for default region.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>awr eu-central-1 Pre-sort the allowed regions list with the entered keyword. If multiple regions matches the keyword, user is prompted to select profile from a list. If only a single match is found that region is directly selected without further user prompts. Selected region exported to $env:AWS_REGION environment variable</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-AWSVariables</command:name> <command:verb>Show</command:verb> <command:noun>AWSVariables</command:noun> <maml:description> <maml:para>List selected or all AWS profile and session related environment variables.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>List selected or all AWS profile and session related environment variables.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-AWSVariables</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>awl List all environment variables starting with $Env:AWS_</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |