openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: 'APIs.io Engineering Platform Amazon API Gateway 2014 11 13 #Action=ResetServiceSpecificCredential API' description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#Action=ResetServiceSpecificCredential' paths: /#Action=ResetServiceSpecificCredential: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: x-aws-operation-name: ResetServiceSpecificCredential operationId: GET_ResetServiceSpecificCredential description: Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ResetServiceSpecificCredentialResponse' '480': description: NoSuchEntityException content: text/xml: schema: $ref: '#/components/schemas/NoSuchEntityException' parameters: - name: UserName in: query required: false description: '

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' schema: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 64 - name: ServiceSpecificCredentialId in: query required: true description:

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

schema: type: string pattern: '[\w]+' minLength: 20 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - ResetServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 tags: - '#Action=ResetServiceSpecificCredential' post: x-aws-operation-name: ResetServiceSpecificCredential operationId: POST_ResetServiceSpecificCredential description: Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ResetServiceSpecificCredentialResponse' '480': description: NoSuchEntityException content: text/xml: schema: $ref: '#/components/schemas/NoSuchEntityException' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ResetServiceSpecificCredentialRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ResetServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 tags: - '#Action=ResetServiceSpecificCredential' components: parameters: X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false schemas: servicePassword: type: string format: password ResetServiceSpecificCredentialRequest: type: object required: - ServiceSpecificCredentialId title: ResetServiceSpecificCredentialRequest properties: UserName: allOf: - $ref: '#/components/schemas/userNameType' - description: '

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' ServiceSpecificCredentialId: allOf: - $ref: '#/components/schemas/serviceSpecificCredentialId' - description:

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

statusType: type: string enum: - Active - Inactive ServiceSpecificCredential: type: object required: - CreateDate - ServiceName - ServiceUserName - ServicePassword - ServiceSpecificCredentialId - UserName - Status properties: CreateDate: allOf: - $ref: '#/components/schemas/dateType' - description: The date and time, in ISO 8601 date-time format, when the service-specific credential were created. ServiceName: allOf: - $ref: '#/components/schemas/serviceName' - description: The name of the service associated with the service-specific credential. ServiceUserName: allOf: - $ref: '#/components/schemas/serviceUserName' - description: The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user. ServicePassword: allOf: - $ref: '#/components/schemas/servicePassword' - description: The generated password for the service-specific credential. ServiceSpecificCredentialId: allOf: - $ref: '#/components/schemas/serviceSpecificCredentialId' - description: The unique identifier for the service-specific credential. UserName: allOf: - $ref: '#/components/schemas/userNameType' - description: The name of the IAM user associated with the service-specific credential. Status: allOf: - $ref: '#/components/schemas/statusType' - description: The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not. description: Contains the details of a service-specific credential. serviceName: type: string NoSuchEntityException: {} dateType: type: string format: date-time userNameType: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 64 ResetServiceSpecificCredentialResponse: type: object properties: ServiceSpecificCredential: allOf: - $ref: '#/components/schemas/ServiceSpecificCredential' - description:

A structure with details about the updated service-specific credential, including the new password.

This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.

serviceUserName: type: string pattern: '[\w+=,.@-]+' minLength: 17 maxLength: 200 serviceSpecificCredentialId: type: string pattern: '[\w]+' minLength: 20 maxLength: 128 securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true