aws-account
This topic describes the verbs, command-line arguments, and API parameters available for the aws-account noun in the BMC Cloud Lifecycle Management SDK. (This call is available when the provider is defined as AWS.)
list
Use aws-account-list from the command line to list configured AWS accounts.
[--filter FIELD_NAME=VALUE [FIELD_NAME=VALUE ...]] --provider NAME|id:<GUID>
Use aws_account_list to list configured AWS accounts using the API. This command returns a list of LogicalDataCenterUserMap API objects with the same attributes and relationships.
obj[n].guid returns the GUID
obj[n].name returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--provider | provider | Name or GUID of the provider. | Yes |
-l |
| List all fields. This parameter does not need a value. |
|
-u |
| List only GUIDs. This parameter does not need a value. |
|
-n |
| List only names. This parameter does not need a value. |
|
-s |
| List GUIDs, names, and status (if applicable). This parameter does not need a value. |
|
-k |
| List the field names specified as the value for this parameter. |
|
--filter | filters | Filter the output according to the specified criteria. |
|
| fieldInfo | list of OM attributes and relations such as ([‘name’, ‘tags.*’, ‘inPool.*’]) |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
map-to
Use aws-account-map-to from the command line to register an AWS account.
--accountname NAME --key NAME --sharedsecret NAME
Use aws_account_map in the API to register an AWS account. This command affects a
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--provider | provider | Name or GUID of the provider. | Yes |
--accountname | accountName | Account user name. | Yes |
--key | key | AWS API access key. | Yes |
--sharedsecret | sharedSecret | AWS API shared secret. | Yes |
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
unmap-to
Use aws-account-unmap-to from the command line to unregister an AWS account.
--accountname NAME
Use aws_account_unmap in the API to unregister an AWS account. This command affects a
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--provider | provider | Name or GUID of the provider. | Yes |
--accountname | accountName | Account user name. | Yes |
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|