ImportApiKeys
Import API keys from an external source, such as a CSV-formatted file.
Request Syntax
POST /apikeys?mode=import&failonwarnings=failOnWarnings
&format=format
HTTP/1.1
body
URI Request Parameters
The request uses the following URI parameters.
- failOnWarnings
-
A query parameter to indicate whether to rollback ApiKey importation (
true
) or not (false
) when error is encountered. - format
-
A query parameter to specify the input format to imported API keys. Currently, only the
csv
format is supported.Valid Values:
csv
Required: Yes
Request Body
The request accepts the following binary data.
- body
-
The payload of the POST request to import API keys. For the payload format, see API Key File Format.
Required: Yes
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"ids": [ "string" ],
"warnings": [ "string" ]
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
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: