paulrenenichols / aws-pinpoint

simple command line tool for managing aws pinpoint projects

aws-pinpoint

Simple utility for creating, updating, and deleting aws pinpoint projects

• Usage
• Commands

Usage

$ npm install -g aws-pinpoint
$ aws-pinpoint COMMAND
running command...
$ aws-pinpoint (-v|--version|version)
aws-pinpoint/0.0.0 darwin-x64 node-v10.9.0
$ aws-pinpoint --help [COMMAND]
USAGE
  $ aws-pinpoint COMMAND
...

Commands

• aws-pinpoint create
• aws-pinpoint delete
• aws-pinpoint update
• aws-pinpoint help [COMMAND]

aws-pinpoint create

Create an AWS Pinpoint project.

USAGE
  $ aws-pinpoint create --profile <admin-account-profile> \
                        --roleARN <arn-of-role-to-assume> \
                        --appName <pinpoint-app-name> \
                        --region <aws-region-name>

OPTIONS
  --profile=profile  The name of the saved AWS profile to use for credentials.
                     this is intended to be the organizational, 
                     or admin, account.
                     
  --roleARN=roleARN  the Amazon Resource Name (ARN) of the role to assume when 
                     creating the Pinpoint project. for cross account access,
                     this should be an admin privileged role for an account 
                     within your AWS Organization.
  
  --appName=appName  the name of the AWS Pinpoint app or project that 
                     will be created.
                     
  --region=region.   the name of the region within which the AWS Pinpoint app
                     or project will be created.

See code: src/commands/create.js

aws-pinpoint delete

Describe the command here

USAGE
  $ aws-pinpoint delete --profile <admin-account-profile> \
                        --roleARN <arn-of-role-to-assume> \
                        --appId <pinpoint-app-id> \
                        --region <aws-region-name>

OPTIONS
  --profile=profile  The name of the saved AWS profile to use for credentials.
                     this is intended to be the organizational, 
                     or admin, account.
                     
  --roleARN=roleARN  the Amazon Resource Name (ARN) of the role to assume when 
                     creating the Pinpoint project. for cross account access,
                     this should be an admin privileged role for an account 
                     within your AWS Organization.
  
  --appId=appId      the id of the AWS Pinpoint app or project that 
                     will be deleted.
                     
  --region=region.   the name of the region within which the AWS Pinpoint app
                     or project will be deleted.

See code: src/commands/delete.js

aws-pinpoint update

Describe the command here

USAGE
  $ aws-pinpoint update --profile <admin-account-profile> \
                        --roleARN <arn-of-role-to-assume> \
                        --appName <pinpoint-app-name> \
                        --appId <pinpoint-app-id> \
                        --region <aws-region-name>

OPTIONS
  --profile=profile  The name of the saved AWS profile to use for credentials.
                     this is intended to be the organizational, 
                     or admin, account.
                     
  --roleARN=roleARN  the Amazon Resource Name (ARN) of the role to assume when 
                     creating the Pinpoint project. for cross account access,
                     this should be an admin privileged role for an account 
                     within your AWS Organization.
  
  --appId=appId      the id of the AWS Pinpoint app or project that 
                     will be updated.
                     
  --appName=appName  the name of the AWS Pinpoint app or project that 
                     will be updated.
                     
  --region=region.   the name of the region within which the AWS Pinpoint app
                     or project will be updated.

See code: src/commands/update.js

aws-pinpoint help [COMMAND]

display help for aws-pinpoint

USAGE
  $ aws-pinpoint help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help