Class: Aws::AppSync::Types::UpdateApiKeyRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::UpdateApiKeyRequest

Defined in:

gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Note:

When making an API call, you may pass UpdateApiKeyRequest data as a hash:

{
  api_id: "String", # required
  id: "String", # required
  description: "String",
  expires: 1,
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_id ⇒ String

  The ID for the GraphQL API.

• #description ⇒ String

  A description of the purpose of the API key.

• #expires ⇒ Integer

  The time from update time after which the API key expires.

• #id ⇒ String

  The API key ID.

Instance Attribute Details

#api_id ⇒ String

The ID for the GraphQL API.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 3152

class UpdateApiKeyRequest < Struct.new(
  :api_id,
  :id,
  :description,
  :expires)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the purpose of the API key.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 3152

class UpdateApiKeyRequest < Struct.new(
  :api_id,
  :id,
  :description,
  :expires)
  SENSITIVE = []
  include Aws::Structure
end

#expires ⇒ Integer

The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

Returns:

• (Integer)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 3152

class UpdateApiKeyRequest < Struct.new(
  :api_id,
  :id,
  :description,
  :expires)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The API key ID.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 3152

class UpdateApiKeyRequest < Struct.new(
  :api_id,
  :id,
  :description,
  :expires)
  SENSITIVE = []
  include Aws::Structure
end