AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.APIGateway.Model.CreateApiKeyResponse

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class CreateApiKeyResponse : AmazonWebServiceResponse

The CreateApiKeyResponse type exposes the following members

Constructors

NameDescription
Public Method CreateApiKeyResponse()

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreatedDate System.DateTime

Gets and sets the property CreatedDate.

The timestamp when the API Key was created.

Public Property CustomerId System.String

Gets and sets the property CustomerId.

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

Public Property Description System.String

Gets and sets the property Description.

The description of the API Key.

Public Property Enabled System.Boolean

Gets and sets the property Enabled.

Specifies whether the API Key can be used by callers.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Id System.String

Gets and sets the property Id.

The identifier of the API Key.

Public Property LastUpdatedDate System.DateTime

Gets and sets the property LastUpdatedDate.

The timestamp when the API Key was last updated.

Public Property Name System.String

Gets and sets the property Name.

The name of the API Key.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property StageKeys System.Collections.Generic.List<System.String>

Gets and sets the property StageKeys.

A list of Stage resources that are associated with the ApiKey resource.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

The collection of tags. Each tag element is associated with a given resource.

Public Property Value System.String

Gets and sets the property Value.

The value of the API Key.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5