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

update-graphql-api

Description

Updates a GraphqlApi object.

See also: AWS API Documentation

Synopsis

  update-graphql-api
--api-id <value>
--name <value>
[--log-config <value>]
[--authentication-type <value>]
[--user-pool-config <value>]
[--open-id-connect-config <value>]
[--additional-authentication-providers <value>]
[--xray-enabled | --no-xray-enabled]
[--lambda-authorizer-config <value>]
[--merged-api-execution-role-arn <value>]
[--owner-contact <value>]
[--introspection-config <value>]
[--query-depth-limit <value>]
[--resolver-count-limit <value>]
[--enhanced-metrics-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 new name for the GraphqlApi object.

--log-config (structure)

The Amazon CloudWatch Logs configuration for the GraphqlApi object.

fieldLogLevel -> (string)

The field logging level. Values can be NONE, ERROR, or ALL.

  • NONE : No field-level logs are captured.
  • ERROR : Logs the following information only for the fields that are in error:
    • The error section in the server response.
    • Field-level errors.
    • The generated request/response functions that got resolved for error fields.
  • ALL : The following information is logged for all fields in the query:
    • Field-level tracing information.
    • The generated request/response functions that got resolved for each field.

cloudWatchLogsRoleArn -> (string)

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

excludeVerboseContent -> (boolean)

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

Shorthand Syntax:

fieldLogLevel=string,cloudWatchLogsRoleArn=string,excludeVerboseContent=boolean

JSON Syntax:

{
  "fieldLogLevel": "NONE"|"ERROR"|"ALL"|"INFO"|"DEBUG",
  "cloudWatchLogsRoleArn": "string",
  "excludeVerboseContent": true|false
}

--authentication-type (string)

The new authentication type for the GraphqlApi object.

Possible values:

  • API_KEY
  • AWS_IAM
  • AMAZON_COGNITO_USER_POOLS
  • OPENID_CONNECT
  • AWS_LAMBDA

--user-pool-config (structure)

The new Amazon Cognito user pool configuration for the ~GraphqlApi object.

userPoolId -> (string)

The user pool ID.

awsRegion -> (string)

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

defaultAction -> (string)

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

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.

Shorthand Syntax:

userPoolId=string,awsRegion=string,defaultAction=string,appIdClientRegex=string

JSON Syntax:

{
  "userPoolId": "string",
  "awsRegion": "string",
  "defaultAction": "ALLOW"|"DENY",
  "appIdClientRegex": "string"
}

--open-id-connect-config (structure)

The OpenID Connect configuration for the GraphqlApi object.

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.

Shorthand Syntax:

issuer=string,clientId=string,iatTTL=long,authTTL=long

JSON Syntax:

{
  "issuer": "string",
  "clientId": "string",
  "iatTTL": long,
  "authTTL": long
}

--additional-authentication-providers (list)

A list of additional authentication providers for the GraphqlApi API.

(structure)

Describes an additional authentication provider.

authenticationType -> (string)

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

openIDConnectConfig -> (structure)

The 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.

userPoolConfig -> (structure)

The 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.

lambdaAuthorizerConfig -> (structure)

Configuration for Lambda function authorization.

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.

Shorthand Syntax:

authenticationType=string,openIDConnectConfig={issuer=string,clientId=string,iatTTL=long,authTTL=long},userPoolConfig={userPoolId=string,awsRegion=string,appIdClientRegex=string},lambdaAuthorizerConfig={authorizerResultTtlInSeconds=integer,authorizerUri=string,identityValidationExpression=string} ...

JSON Syntax:

[
  {
    "authenticationType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA",
    "openIDConnectConfig": {
      "issuer": "string",
      "clientId": "string",
      "iatTTL": long,
      "authTTL": long
    },
    "userPoolConfig": {
      "userPoolId": "string",
      "awsRegion": "string",
      "appIdClientRegex": "string"
    },
    "lambdaAuthorizerConfig": {
      "authorizerResultTtlInSeconds": integer,
      "authorizerUri": "string",
      "identityValidationExpression": "string"
    }
  }
  ...
]

--xray-enabled | --no-xray-enabled (boolean)

A flag indicating whether to use X-Ray tracing for the GraphqlApi .

--lambda-authorizer-config (structure)

Configuration for Lambda function authorization.

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.

Shorthand Syntax:

authorizerResultTtlInSeconds=integer,authorizerUri=string,identityValidationExpression=string

JSON Syntax:

{
  "authorizerResultTtlInSeconds": integer,
  "authorizerUri": "string",
  "identityValidationExpression": "string"
}

--merged-api-execution-role-arn (string)

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

--owner-contact (string)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

--introspection-config (string)

Sets the value of the GraphQL API to enable (ENABLED ) or disable (DISABLED ) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection .

Possible values:

  • ENABLED
  • DISABLED

--query-depth-limit (integer)

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

--resolver-count-limit (integer)

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000 . When specified, the limit value can be between 1 and 10000 . This field will produce a limit error if the operation falls out of bounds.

--enhanced-metrics-config (structure)

The enhancedMetricsConfig object.

resolverLevelMetricsBehavior -> (string)

Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

  • GraphQL errors: The number of GraphQL errors that occurred.
  • Requests: The number of invocations that occurred during a request.
  • Latency: The time to complete a resolver invocation.
  • Cache hits: The number of cache hits during a request.
  • Cache misses: The number of cache misses during a request.

These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:

  • FULL_REQUEST_RESOLVER_METRICS : Records and emits metric data for all resolvers in the request.
  • PER_RESOLVER_METRICS : Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED .

dataSourceLevelMetricsBehavior -> (string)

Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

  • Requests: The number of invocations that occured during a request.
  • Latency: The time to complete a data source invocation.
  • Errors: The number of errors that occurred during a data source invocation.

These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:

  • FULL_REQUEST_DATA_SOURCE_METRICS : Records and emits metric data for all data sources in the request.
  • PER_DATA_SOURCE_METRICS : Records and emits metric data for data sources that have the metricsConfig value set to ENABLED .

operationLevelMetricsConfig -> (string)

Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

  • Requests: The number of times a specified GraphQL operation was called.
  • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.

Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or DISABLED .

Shorthand Syntax:

resolverLevelMetricsBehavior=string,dataSourceLevelMetricsBehavior=string,operationLevelMetricsConfig=string

JSON Syntax:

{
  "resolverLevelMetricsBehavior": "FULL_REQUEST_RESOLVER_METRICS"|"PER_RESOLVER_METRICS",
  "dataSourceLevelMetricsBehavior": "FULL_REQUEST_DATA_SOURCE_METRICS"|"PER_DATA_SOURCE_METRICS",
  "operationLevelMetricsConfig": "ENABLED"|"DISABLED"
}

--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

graphqlApi -> (structure)

The updated GraphqlApi object.

name -> (string)

The API name.

apiId -> (string)

The API ID.

authenticationType -> (string)

The authentication type.

logConfig -> (structure)

The Amazon CloudWatch Logs configuration.

fieldLogLevel -> (string)

The field logging level. Values can be NONE, ERROR, or ALL.

  • NONE : No field-level logs are captured.
  • ERROR : Logs the following information only for the fields that are in error:
    • The error section in the server response.
    • Field-level errors.
    • The generated request/response functions that got resolved for error fields.
  • ALL : The following information is logged for all fields in the query:
    • Field-level tracing information.
    • The generated request/response functions that got resolved for each field.

cloudWatchLogsRoleArn -> (string)

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

excludeVerboseContent -> (boolean)

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

userPoolConfig -> (structure)

The 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.

defaultAction -> (string)

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

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)

The OpenID Connect 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.

arn -> (string)

The Amazon Resource Name (ARN).

uris -> (map)

The URIs.

key -> (string)

value -> (string)

tags -> (map)

The tags.

key -> (string)

The key for the tag.

value -> (string)

The value for the tag.

additionalAuthenticationProviders -> (list)

A list of additional authentication providers for the GraphqlApi API.

(structure)

Describes an additional authentication provider.

authenticationType -> (string)

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

openIDConnectConfig -> (structure)

The 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.

userPoolConfig -> (structure)

The 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.

lambdaAuthorizerConfig -> (structure)

Configuration for Lambda function authorization.

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.

xrayEnabled -> (boolean)

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

wafWebAclArn -> (string)

The ARN of the WAF access control list (ACL) associated with this GraphqlApi , if one exists.

lambdaAuthorizerConfig -> (structure)

Configuration for Lambda function authorization.

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.

dns -> (map)

The DNS records for the API.

key -> (string)

value -> (string)

visibility -> (string)

Sets the value of the GraphQL API to public (GLOBAL ) or private (PRIVATE ). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

apiType -> (string)

The value that indicates whether the GraphQL API is a standard API (GRAPHQL ) or merged API (MERGED ).

mergedApiExecutionRoleArn -> (string)

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

owner -> (string)

The account owner of the GraphQL API.

ownerContact -> (string)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

introspectionConfig -> (string)

Sets the value of the GraphQL API to enable (ENABLED ) or disable (DISABLED ) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection .

queryDepthLimit -> (integer)

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

resolverCountLimit -> (integer)

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000 . When specified, the limit value can be between 1 and 10000 . This field will produce a limit error if the operation falls out of bounds.

enhancedMetricsConfig -> (structure)

The enhancedMetricsConfig object.

resolverLevelMetricsBehavior -> (string)

Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

  • GraphQL errors: The number of GraphQL errors that occurred.
  • Requests: The number of invocations that occurred during a request.
  • Latency: The time to complete a resolver invocation.
  • Cache hits: The number of cache hits during a request.
  • Cache misses: The number of cache misses during a request.

These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:

  • FULL_REQUEST_RESOLVER_METRICS : Records and emits metric data for all resolvers in the request.
  • PER_RESOLVER_METRICS : Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED .

dataSourceLevelMetricsBehavior -> (string)

Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

  • Requests: The number of invocations that occured during a request.
  • Latency: The time to complete a data source invocation.
  • Errors: The number of errors that occurred during a data source invocation.

These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:

  • FULL_REQUEST_DATA_SOURCE_METRICS : Records and emits metric data for all data sources in the request.
  • PER_DATA_SOURCE_METRICS : Records and emits metric data for data sources that have the metricsConfig value set to ENABLED .

operationLevelMetricsConfig -> (string)

Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

  • Requests: The number of times a specified GraphQL operation was called.
  • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.

Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or DISABLED .