openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: 'APIs.io Engineering Platform Amazon API Gateway 2014 11 13 #Action=GetServiceLinkedRoleDeletionStatus API'
description:
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=GetServiceLinkedRoleDeletionStatus' paths: /#Action=GetServiceLinkedRoleDeletionStatus: 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: GetServiceLinkedRoleDeletionStatus operationId: GET_GetServiceLinkedRoleDeletionStatus description: Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use theDeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse'
'480':
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: '#/components/schemas/NoSuchEntityException'
'481':
description: InvalidInputException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidInputException'
'482':
description: ServiceFailureException
content:
text/xml:
schema:
$ref: '#/components/schemas/ServiceFailureException'
parameters:
- name: DeletionTaskId
in: query
required: true
description: The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
schema:
type: string
minLength: 1
maxLength: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLinkedRoleDeletionStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
tags:
- '#Action=GetServiceLinkedRoleDeletionStatus'
post:
x-aws-operation-name: GetServiceLinkedRoleDeletionStatus
operationId: POST_GetServiceLinkedRoleDeletionStatus
description: Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse'
'480':
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: '#/components/schemas/NoSuchEntityException'
'481':
description: InvalidInputException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidInputException'
'482':
description: ServiceFailureException
content:
text/xml:
schema:
$ref: '#/components/schemas/ServiceFailureException'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLinkedRoleDeletionStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
tags:
- '#Action=GetServiceLinkedRoleDeletionStatus'
components:
parameters:
X-Amz-Signature:
name: X-Amz-Signature
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-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
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-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
schemas:
GetServiceLinkedRoleDeletionStatusRequest:
type: object
required:
- DeletionTaskId
title: GetServiceLinkedRoleDeletionStatusRequest
properties:
DeletionTaskId:
allOf:
- $ref: '#/components/schemas/DeletionTaskIdType'
- description: The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
InvalidInputException: {}
ReasonType:
type: string
maxLength: 1000
ArnListType:
type: array
items:
$ref: '#/components/schemas/arnType'
RoleUsageType:
type: object
properties:
Region:
allOf:
- $ref: '#/components/schemas/RegionNameType'
- description: The name of the Region where the service-linked role is being used.
Resources:
allOf:
- $ref: '#/components/schemas/ArnListType'
- description: The name of the resource that is using the service-linked role.
description: An object that contains details about how a service-linked role is used, if that information is returned by the service.
This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
arnType: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 GetServiceLinkedRoleDeletionStatusResponse: type: object required: - Status properties: Status: allOf: - $ref: '#/components/schemas/DeletionTaskStatusType' - description: The status of the deletion. Reason: allOf: - $ref: '#/components/schemas/DeletionTaskFailureReasonType' - description: An object that contains details about the reason the deletion failed. DeletionTaskIdType: type: string minLength: 1 maxLength: 1000 DeletionTaskStatusType: type: string enum: - SUCCEEDED - IN_PROGRESS - FAILED - NOT_STARTED RegionNameType: type: string minLength: 1 maxLength: 100 NoSuchEntityException: {} ServiceFailureException: {} DeletionTaskFailureReasonType: type: object properties: Reason: allOf: - $ref: '#/components/schemas/ReasonType' - description: A short description of the reason that the service-linked role deletion failed. RoleUsageList: allOf: - $ref: '#/components/schemas/RoleUsageListType' - description: A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the Region in which the resources are being used. description:The reason that the service-linked role deletion failed.
This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
RoleUsageListType: type: array items: $ref: '#/components/schemas/RoleUsageType' 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