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 . appsync ]

update-api¶

Description¶

Updates an Api .

Synopsis¶

  update-api
--api-id <value>
--name <value>
[--owner-contact <value>]
[--event-config <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¶

--api-id (string)

The Api ID.

--name (string)

The name of the Api.

--owner-contact (string)

The owner contact information for the Api .

--event-config (structure)

The new event configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

authProviders -> (list)

A list of authorization providers.

(structure)

Describes an authorization provider.

authType -> (string)

The authorization type.

cognitoConfig -> (structure)

Describes an Amazon Cognito user pool configuration.

userPoolId -> (string)

The user pool ID.

awsRegion -> (string)

The Amazon Web Services Region in which the user pool was created.

appIdClientRegex -> (string)

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

openIDConnectConfig -> (structure)

Describes an OpenID Connect (OIDC) configuration.

issuer -> (string)

The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

clientId -> (string)

The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

iatTTL -> (long)

The number of milliseconds that a token is valid after it's issued to a user.

authTTL -> (long)

The number of milliseconds that a token is valid after being authenticated.

lambdaAuthorizerConfig -> (structure)

A LambdaAuthorizerConfig specifies how to authorize AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.

authorizerResultTtlInSeconds -> (integer)

The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds , the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

authorizerUri -> (string)

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3 ), or an alias ARN.

Note : This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

identityValidationExpression -> (string)

A regular expression for validation of tokens before the Lambda function is called.

connectionAuthModes -> (list)

A list of valid authorization modes for the Event API connections.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

defaultPublishAuthModes -> (list)

A list of valid authorization modes for the Event API publishing.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

defaultSubscribeAuthModes -> (list)

A list of valid authorization modes for the Event API subscriptions.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

logConfig -> (structure)

The CloudWatch Logs configuration for the Event API.

logLevel -> (string)

The type of information to log for the Event API.

cloudWatchLogsRoleArn -> (string)

The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.

JSON Syntax:

{
  "authProviders": [
    {
      "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA",
      "cognitoConfig": {
        "userPoolId": "string",
        "awsRegion": "string",
        "appIdClientRegex": "string"
      },
      "openIDConnectConfig": {
        "issuer": "string",
        "clientId": "string",
        "iatTTL": long,
        "authTTL": long
      },
      "lambdaAuthorizerConfig": {
        "authorizerResultTtlInSeconds": integer,
        "authorizerUri": "string",
        "identityValidationExpression": "string"
      }
    }
    ...
  ],
  "connectionAuthModes": [
    {
      "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
    }
    ...
  ],
  "defaultPublishAuthModes": [
    {
      "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
    }
    ...
  ],
  "defaultSubscribeAuthModes": [
    {
      "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
    }
    ...
  ],
  "logConfig": {
    "logLevel": "NONE"|"ERROR"|"ALL"|"INFO"|"DEBUG",
    "cloudWatchLogsRoleArn": "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¶

api -> (structure)

The Api object.

apiId -> (string)

The Api ID.

name -> (string)

The name of the Api .

ownerContact -> (string)

The owner contact information for the Api

tags -> (map)

A map with keys of TagKey objects and values of TagValue objects.

key -> (string)

The key for the tag.

value -> (string)

The value for the tag.

dns -> (map)

The DNS records for the API. This will include an HTTP and a real-time endpoint.

key -> (string)

value -> (string)

apiArn -> (string)

The Amazon Resource Name (ARN) for the Api .

created -> (timestamp)

The date and time that the Api was created.

xrayEnabled -> (boolean)

A flag indicating whether to use X-Ray tracing for this Api .

wafWebAclArn -> (string)

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api , if one exists.

eventConfig -> (structure)

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

authProviders -> (list)

A list of authorization providers.

(structure)

Describes an authorization provider.

authType -> (string)

The authorization type.

cognitoConfig -> (structure)

Describes an Amazon Cognito user pool configuration.

userPoolId -> (string)

The user pool ID.

awsRegion -> (string)

The Amazon Web Services Region in which the user pool was created.

appIdClientRegex -> (string)

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

openIDConnectConfig -> (structure)

Describes an OpenID Connect (OIDC) configuration.

issuer -> (string)

The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

clientId -> (string)

The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

iatTTL -> (long)

The number of milliseconds that a token is valid after it's issued to a user.

authTTL -> (long)

The number of milliseconds that a token is valid after being authenticated.

lambdaAuthorizerConfig -> (structure)

A LambdaAuthorizerConfig specifies how to authorize AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.

authorizerResultTtlInSeconds -> (integer)

The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds , the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

authorizerUri -> (string)

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3 ), or an alias ARN.

Note : This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

identityValidationExpression -> (string)

A regular expression for validation of tokens before the Lambda function is called.

connectionAuthModes -> (list)

A list of valid authorization modes for the Event API connections.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

defaultPublishAuthModes -> (list)

A list of valid authorization modes for the Event API publishing.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

defaultSubscribeAuthModes -> (list)

A list of valid authorization modes for the Event API subscriptions.

(structure)

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

authType -> (string)

The authorization type.

logConfig -> (structure)

The CloudWatch Logs configuration for the Event API.

logLevel -> (string)

The type of information to log for the Event API.

cloudWatchLogsRoleArn -> (string)

The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.

Table Of Contents

Feedback

User Guide