Amazon Incident Manager GetReplicationSet#arn API
The GetReplicationSet#arn API from Amazon Incident Manager — 1 operation(s) for getreplicationset#arn.
The GetReplicationSet#arn API from Amazon Incident Manager — 1 operation(s) for getreplicationset#arn.
openapi: 3.0.0
info:
version: 2018-05-10
x-release: v4
title: AWS Systems Manager Incident Manager CreateReplicationSet GetReplicationSet#arn API
description: <p>Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services. </p> <p>Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation. </p>
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: ssm-incidents
x-aws-signingName: ssm-incidents
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ssm-incidents-2018-05-10.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://ssm-incidents.{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 SSM Incidents multi-region endpoint
- url: https://ssm-incidents.{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 SSM Incidents multi-region endpoint
- url: http://ssm-incidents.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The SSM Incidents endpoint for China (Beijing) and China (Ningxia)
- url: https://ssm-incidents.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The SSM Incidents endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: GetReplicationSet#arn
paths:
/getReplicationSet#arn:
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:
operationId: GetReplicationSet
description: Retrieve your Incident Manager replication set.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetReplicationSetOutput'
'480':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: arn
in: query
required: true
description: The Amazon Resource Name (ARN) of the replication set you want to retrieve.
schema:
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
summary: Amazon Incident Manager Get Replication Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- GetReplicationSet#arn
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:
AccessDeniedException: {}
ThrottlingException: {}
RegionInfoMap:
type: object
additionalProperties:
$ref: '#/components/schemas/RegionInfo'
Boolean:
type: boolean
Arn:
type: string
pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
minLength: 0
maxLength: 1000
Timestamp:
type: string
format: date-time
SseKmsKey:
type: string
minLength: 0
maxLength: 2048
String:
type: string
RegionStatus:
type: string
enum:
- ACTIVE
- CREATING
- DELETING
- FAILED
InternalServerException: {}
ReplicationSetStatus:
type: string
enum:
- ACTIVE
- CREATING
- UPDATING
- DELETING
- FAILED
ReplicationSet:
type: object
required:
- createdBy
- createdTime
- deletionProtected
- lastModifiedBy
- lastModifiedTime
- regionMap
- status
properties:
arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the replication set.
createdBy:
allOf:
- $ref: '#/components/schemas/Arn'
- description: Details about who created the replication set.
createdTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the replication set was created.
deletionProtected:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can''t delete the last Amazon Web Services Region in the replication set. '
lastModifiedBy:
allOf:
- $ref: '#/components/schemas/Arn'
- description: Who last modified the replication set.
lastModifiedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the replication set was last updated.
regionMap:
allOf:
- $ref: '#/components/schemas/RegionInfoMap'
- description: The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.
status:
allOf:
- $ref: '#/components/schemas/ReplicationSetStatus'
- description: The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.
description: 'The set of Amazon Web Services Region that your Incident Manager data will be replicated to and the KMS key used to encrypt the data. '
ResourceNotFoundException: {}
GetReplicationSetOutput:
type: object
required:
- replicationSet
properties:
replicationSet:
allOf:
- $ref: '#/components/schemas/ReplicationSet'
- description: Details of the replication set.
ValidationException: {}
RegionInfo:
type: object
required:
- status
- statusUpdateDateTime
properties:
sseKmsKeyId:
allOf:
- $ref: '#/components/schemas/SseKmsKey'
- description: The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.
status:
allOf:
- $ref: '#/components/schemas/RegionStatus'
- description: The status of the Amazon Web Services Region in the replication set.
statusMessage:
allOf:
- $ref: '#/components/schemas/String'
- description: Information displayed about the status of the Amazon Web Services Region.
statusUpdateDateTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.
description: Information about a Amazon Web Services Region in your replication set.
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/ssm-incidents/
x-hasEquivalentPaths: true