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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::DescribeKeyResponse

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:key]

Instance Attribute Summary

• #create_time ⇒ Time

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

• #description ⇒ String

  The optional description for the API key resource.

• #expire_time ⇒ Time

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

• #key ⇒ String

  The key value/string of an API key.

• #key_arn ⇒ String

  The Amazon Resource Name (ARN) for the API key resource.

• #key_name ⇒ String

  The name of the API key resource.

• #restrictions ⇒ Types::ApiKeyRestrictions

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

• #tags ⇒ Hash<String,String>

  Tags associated with the API key resource.

• #update_time ⇒ Time

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

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.

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

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

#description ⇒ String

The optional description for the API key resource.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

class DescribeKeyResponse < Struct.new(
  :create_time,
  :description,
  :expire_time,
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :tags,
  :update_time)
  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.

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

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

#key ⇒ String

The key value/string of an API key.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

class DescribeKeyResponse < Struct.new(
  :create_time,
  :description,
  :expire_time,
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :tags,
  :update_time)
  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)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

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

#key_name ⇒ String

The name of the API key resource.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

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

#restrictions ⇒ Types::ApiKeyRestrictions

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

Returns:

• (Types::ApiKeyRestrictions)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

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

#tags ⇒ Hash<String,String>

Tags associated with the API key resource.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

class DescribeKeyResponse < Struct.new(
  :create_time,
  :description,
  :expire_time,
  :key,
  :key_arn,
  :key_name,
  :restrictions,
  :tags,
  :update_time)
  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.

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 2387

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