Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

RegisterSubscriptionProvider

Request Syntax


POST /subscription/RegisterSubscriptionProvider HTTP/1.1
Content-type: application/json

{
   "SecretArn": "string",
   "SubscriptionProviderSource": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

SecretArn

The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token.

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:secretsmanager:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:secret:[^/]{1,1023}$

Required: Yes

SubscriptionProviderSource

The supported Linux subscription provider to register.

Type: String

Valid Values: RedHat

Required: Yes

Tags

The metadata tags to assign to your registered Linux subscription provider resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SubscriptionProviderArn": "string",
   "SubscriptionProviderSource": "string",
   "SubscriptionProviderStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SubscriptionProviderArn

The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.

Type: String

SubscriptionProviderSource

The Linux subscription provider that you registered.

Type: String

Valid Values: RedHat

SubscriptionProviderStatus

Indicates the status of the registration action for the Linux subscription provider that you requested.

Type: String

Valid Values: ACTIVE | INVALID | PENDING

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The provided input is not valid. Try your request again.

HTTP Status Code: 400