Class: Aws::LocationService::Types::DescribeKeyResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-locationservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:key]

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ Time

The timestamp for when the API key resource was created in [ ISO 8601] format: ‘YYYY-MM-DDThh:mm:ss.sssZ`.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#description ⇒ String

The optional description for the API key resource.

Returns:

  • (String) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#expire_time ⇒ Time

The timestamp for when the API key resource will expire in [ ISO 8601] format: ‘YYYY-MM-DDThh:mm:ss.sssZ`.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#key ⇒ String

The key value/string of an API key.

Returns:

  • (String) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#key_arn ⇒ String

The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.

  • Format example: ‘arn:aws:geo:region:account-id:key/ExampleKey`

^

Returns:

  • (String) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#key_name ⇒ String

The name of the API key resource.

Returns:

  • (String) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#restrictions ⇒ Types::ApiKeyRestrictions

API Restrictions on the allowed actions, resources, and referers for an API key resource.

Returns:



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags associated with the API key resource.

Returns:

  • (Hash<String,String>) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end

#update_time ⇒ Time

The timestamp for when the API key resource was last updated in [ ISO 8601] format: ‘YYYY-MM-DDThh:mm:ss.sssZ`.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2405

class DescribeKeyResponse < Struct.new(
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :create_time,
  :expire_time,
  :update_time,
  :description,
  :tags)
  SENSITIVE = [:key]
  include Aws::Structure
end