AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appfabric ]

update-app-authorization

Description

Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.

If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.

See also: AWS API Documentation

Synopsis

  update-app-authorization
--app-bundle-identifier <value>
--app-authorization-identifier <value>
[--credential <value>]
[--tenant <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--app-bundle-identifier (string)

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

--app-authorization-identifier (string)

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

--credential (tagged union structure)

Contains credentials for the application, such as an API key or OAuth2 client ID and secret.

Specify credentials that match the authorization type of the app authorization to update. For example, if the authorization type of the app authorization is OAuth2 (oauth2 ), then you should provide only the OAuth2 credentials.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oauth2Credential, apiKeyCredential.

oauth2Credential -> (structure)

Contains OAuth2 client credential information.

clientId -> (string)

The client ID of the client application.

clientSecret -> (string)

The client secret of the client application.

apiKeyCredential -> (structure)

Contains API key credential information.

apiKey -> (string)

An API key for an application.

Shorthand Syntax:

oauth2Credential={clientId=string,clientSecret=string},apiKeyCredential={apiKey=string}

JSON Syntax:

{
  "oauth2Credential": {
    "clientId": "string",
    "clientSecret": "string"
  },
  "apiKeyCredential": {
    "apiKey": "string"
  }
}

--tenant (structure)

Contains information about an application tenant, such as the application display name and identifier.

tenantIdentifier -> (string)

The ID of the application tenant.

tenantDisplayName -> (string)

The display name of the tenant.

Shorthand Syntax:

tenantIdentifier=string,tenantDisplayName=string

JSON Syntax:

{
  "tenantIdentifier": "string",
  "tenantDisplayName": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

appAuthorization -> (structure)

Contains information about an app authorization.

appAuthorizationArn -> (string)

The Amazon Resource Name (ARN) of the app authorization.

appBundleArn -> (string)

The Amazon Resource Name (ARN) of the app bundle for the app authorization.

app -> (string)

The name of the application.

tenant -> (structure)

Contains information about an application tenant, such as the application display name and identifier.

tenantIdentifier -> (string)

The ID of the application tenant.

tenantDisplayName -> (string)

The display name of the tenant.

authType -> (string)

The authorization type.

status -> (string)

The state of the app authorization.

The following states are possible:

  • PendingConnect : The initial state of the app authorization. The app authorization is created but not yet connected.
  • Connected : The app authorization is connected to the application, and is ready to be used.
  • ConnectionValidationFailed : The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
  • TokenAutoRotationFailed : AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.

createdAt -> (timestamp)

The timestamp of when the app authorization was created.

updatedAt -> (timestamp)

The timestamp of when the app authorization was last updated.

persona -> (string)

The user persona of the app authorization.

This field should always be admin .

authUrl -> (string)

The application URL for the OAuth flow.