You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

The ID for the GraphQL API

Returns:

  • (String)


1444
1445
1446
1447
1448
1449
1450
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1444

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

#descriptionString

A description of the purpose of the API key.

Returns:

  • (String)


1444
1445
1446
1447
1448
1449
1450
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1444

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

#expiresInteger

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)


1444
1445
1446
1447
1448
1449
1450
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1444

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

#idString

The API key ID.

Returns:

  • (String)


1444
1445
1446
1447
1448
1449
1450
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1444

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