UpdateApiKey
Changes information about an ApiKey resource.
Request Syntax
PATCH /apikeys/api_Key HTTP/1.1
Content-type: application/json
{
"patchOperations": [
{
"from": "string",
"op": "string",
"path": "string",
"value": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- api_Key
-
The identifier of the ApiKey resource to be updated.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- patchOperations
-
For more information about supported patch operations, see Patch Operations.
Type: Array of PatchOperation objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdDate": number,
"customerId": "string",
"description": "string",
"enabled": boolean,
"id": "string",
"lastUpdatedDate": number,
"name": "string",
"stageKeys": [ "string" ],
"tags": {
"string" : "string"
},
"value": "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.
- createdDate
-
The timestamp when the API Key was created.
Type: Timestamp
- customerId
-
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
Type: String
- description
-
The description of the API Key.
Type: String
- enabled
-
Specifies whether the API Key can be used by callers.
Type: Boolean
- id
-
The identifier of the API Key.
Type: String
- lastUpdatedDate
-
The timestamp when the API Key was last updated.
Type: Timestamp
- name
-
The name of the API Key.
Type: String
- stageKeys
-
A list of Stage resources that are associated with the ApiKey resource.
Type: Array of strings
-
The collection of tags. Each tag element is associated with a given resource.
Type: String to string map
- value
-
The value of the API Key.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
- ConflictException
-
The request configuration has conflicts. For details, see the accompanying error message.
HTTP Status Code: 409
- LimitExceededException
-
The request exceeded the rate limit. Retry after the specified time period.
HTTP Status Code: 429
- NotFoundException
-
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
- TooManyRequestsException
-
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
- UnauthorizedException
-
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
