[ aws . appsync ]

get-graphql-api

Description

Retrieves a GraphqlApi object.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-graphql-api
--api-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API ID for the GraphQL API.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

graphqlApi -> (structure)

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

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.

lambdaAuthorizerConfig -> (structure)

Configuration for Lambda function authorization.

authorizerResultTtlInSeconds -> (integer)

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses.

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 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses.

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.