Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Redshift #Action=CreateHsmConfiguration API

The #Action=CreateHsmConfiguration API from AWS Redshift — 1 operation(s) for #action=createhsmconfiguration.

AWS Redshift #Action=CreateHsmConfiguration API is one of 130 APIs that AWS Redshift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #Action=CreateHsmConfiguration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 2019-12-20.

Requests are made against 4 base URLs: http://redshift-data.{region}.amazonaws.com, https://redshift-data.{region}.amazonaws.com, http://redshift-data.{region}.amazonaws.com.cn, https://redshift-data.{region}.amazonaws.com.cn.

2 operations 1 paths 10 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2019-12-20
Base URL
https://redshift.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Redshift #Action=CreateHsmConfiguration API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

#Action=CreateHsmConfiguration 2
GET
/#Action=CreateHsmConfiguration
Amazon Redshift - G E T Create Hsm Configuration
GET_CreateHsmConfiguration 16 params → 200480481482483
POST
/#Action=CreateHsmConfiguration
Amazon Redshift - P O S T Create Hsm Configuration
POST_CreateHsmConfiguration 9 params body → 200480481482483

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CreateHsmConfigurationMessage (7 properties), HsmConfiguration (5 properties), Tag (2 properties), CreateHsmConfigurationResult (1 property). Each schema is shown below with its type and property counts.

CreateHsmConfigurationResult
object
1 property
HsmConfigurationAlreadyExistsFault
CreateHsmConfigurationMessage
object
7 properties 6 required
Tag
object
A tag consisting of a name/value pair for a resource.
2 properties
TagLimitExceededFault
InvalidTagFault
HsmConfiguration
object
Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM…
5 properties
String
string
TagList
array
HsmConfigurationQuotaExceededFault

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-action-createhsmconfiguration-api-openapi.yml Raw ↑

Other APIs AWS Redshift publishes across the network.

Amazon Redshift Serverless API
AWS Redshift #Action=AcceptReservedNodeExchange API
AWS Redshift #Action=AddPartner API
AWS Redshift #Action=AssociateDataShareConsumer API
AWS Redshift #Action=AuthorizeClusterSecurityGroupIngress API
AWS Redshift #Action=AuthorizeDataShare API
AWS Redshift #Action=AuthorizeEndpointAccess API
AWS Redshift #Action=AuthorizeSnapshotAccess API
AWS Redshift #Action=BatchDeleteClusterSnapshots API
AWS Redshift #Action=BatchModifyClusterSnapshots API
AWS Redshift #Action=CancelResize API
AWS Redshift #Action=CopyClusterSnapshot API