github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/route53-recovery-readiness/2019-12-02/docs-2.json (about)

     1  {
     2    "version" : "2.0",
     3    "service" : "AWS Route53 Recovery Readiness",
     4    "operations" : {
     5      "CreateCell" : "Creates a new Cell.",
     6      "CreateCrossAccountAuthorization" : "Create a new cross account readiness authorization.",
     7      "CreateReadinessCheck" : "Creates a new Readiness Check.",
     8      "CreateRecoveryGroup" : "Creates a new Recovery Group.",
     9      "CreateResourceSet" : "Creates a new Resource Set.",
    10      "DeleteCell" : "Deletes an existing Cell.",
    11      "DeleteCrossAccountAuthorization" : "Delete cross account readiness authorization",
    12      "DeleteReadinessCheck" : "Deletes an existing Readiness Check.",
    13      "DeleteRecoveryGroup" : "Deletes an existing Recovery Group.",
    14      "DeleteResourceSet" : "Deletes an existing Resource Set.",
    15      "GetArchitectureRecommendations" : "Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.",
    16      "GetCell" : "Returns information about a Cell.",
    17      "GetCellReadinessSummary" : "Returns information about readiness of a Cell.",
    18      "GetReadinessCheck" : "Returns information about a ReadinessCheck.",
    19      "GetReadinessCheckResourceStatus" : "Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.",
    20      "GetReadinessCheckStatus" : "Returns information about the status of a Readiness Check.",
    21      "GetRecoveryGroup" : "Returns information about a Recovery Group.",
    22      "GetRecoveryGroupReadinessSummary" : "Returns information about a Recovery Group.",
    23      "GetResourceSet" : "Returns information about a Resource Set.",
    24      "ListCells" : "Returns a collection of Cells.",
    25      "ListCrossAccountAuthorizations" : "Returns a collection of cross account readiness authorizations.",
    26      "ListReadinessChecks" : "Returns a collection of Readiness Checks.",
    27      "ListRecoveryGroups" : "Returns a collection of Recovery Groups.",
    28      "ListResourceSets" : "Returns a collection of Resource Sets.",
    29      "ListRules" : "Returns a collection of rules that are applied as part of Readiness Checks.",
    30      "ListTagsForResources" : "Returns a list of the tags assigned to the specified resource.",
    31      "TagResource" : "Adds tags to the specified resource. You can specify one or more tags to add.",
    32      "UntagResource" : "Removes tags from the specified resource. You can specify one or more tags to remove.",
    33      "UpdateCell" : "Updates an existing Cell.",
    34      "UpdateReadinessCheck" : "Updates an exisiting Readiness Check.",
    35      "UpdateRecoveryGroup" : "Updates an existing Recovery Group.",
    36      "UpdateResourceSet" : "Updates an existing Resource Set."
    37    },
    38    "shapes" : {
    39      "CellCreateParameters" : {
    40        "base" : "Parameters used to create a Cell",
    41        "refs" : { }
    42      },
    43      "CellOutput" : {
    44        "base" : "A Cell and its properties",
    45        "refs" : {
    46          "__listOfCellOutput$member" : null
    47        }
    48      },
    49      "CellUpdateParameters" : {
    50        "base" : "Parameters used to update a Cell",
    51        "refs" : { }
    52      },
    53      "CreateCrossAccountAuthorizationParameters" : {
    54        "base" : "Parameters used to create a cross account authorization",
    55        "refs" : { }
    56      },
    57      "CreateCrossAccountAuthorizationResult" : {
    58        "base" : "The response for a CreateCrossAccountAuthorization operation.",
    59        "refs" : { }
    60      },
    61      "CrossAccountAuthorization" : {
    62        "base" : "A cross-account authorization, e.g. arn:aws:iam::123456789012:root",
    63        "refs" : {
    64          "CreateCrossAccountAuthorizationParameters$CrossAccountAuthorization" : "The cross account authorization",
    65          "CreateCrossAccountAuthorizationResult$CrossAccountAuthorization" : "The cross account authorization",
    66          "__listOfCrossAccountAuthorization$member" : null
    67        }
    68      },
    69      "DNSTargetResource" : {
    70        "base" : "A component for DNS/Routing Control Readiness Checks",
    71        "refs" : {
    72          "Resource$DnsTargetResource" : null
    73        }
    74      },
    75      "DeleteCrossAccountAuthorizationResult" : {
    76        "base" : "The response for a DeleteCrossAccountAuthorization operation.",
    77        "refs" : { }
    78      },
    79      "GetArchitectureRecommendationsOutput" : {
    80        "base" : "Result from GetArchitectureRecommendations",
    81        "refs" : { }
    82      },
    83      "GetCellReadinessSummaryOutput" : {
    84        "base" : "Result of a GetReadinessCellSummary operation",
    85        "refs" : { }
    86      },
    87      "GetReadinessCheckResourceStatusOutput" : {
    88        "base" : "Result of a GetReadinessCheckResourceStatus operation",
    89        "refs" : { }
    90      },
    91      "GetReadinessCheckStatusOutput" : {
    92        "base" : "Result of a GetReadinessCheckStatus operation",
    93        "refs" : { }
    94      },
    95      "GetRecoveryGroupReadinessSummaryOutput" : {
    96        "base" : "Result of a GetReadinessRecoveryGroupSummary operation",
    97        "refs" : { }
    98      },
    99      "LastAuditTimestamp" : {
   100        "base" : "The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format",
   101        "refs" : {
   102          "GetArchitectureRecommendationsOutput$LastAuditTimestamp" : "The time a Recovery Group was last assessed for recommendations in UTC ISO-8601 format."
   103        }
   104      },
   105      "ListCellsResult" : {
   106        "base" : "Response object for listCells",
   107        "refs" : { }
   108      },
   109      "ListCrossAccountAuthorizationsResult" : {
   110        "base" : "The response for a ListCrossAccountAuthorizations operation.",
   111        "refs" : { }
   112      },
   113      "ListReadinessChecksResult" : {
   114        "base" : "Response object for ListReadinessChecks",
   115        "refs" : { }
   116      },
   117      "ListRecoveryGroupsResult" : {
   118        "base" : "Response object for listRecoveryGroups",
   119        "refs" : { }
   120      },
   121      "ListResourceSetsResult" : {
   122        "base" : "Response object for listResourceSets",
   123        "refs" : { }
   124      },
   125      "ListRulesOutput" : {
   126        "base" : "A collection of rules used in a readiness check",
   127        "refs" : {
   128          "__listOfListRulesOutput$member" : null
   129        }
   130      },
   131      "ListRulesResult" : {
   132        "base" : "Response object for List RulePacks",
   133        "refs" : { }
   134      },
   135      "Message" : {
   136        "base" : "Information relating to readiness check status",
   137        "refs" : {
   138          "__listOfMessage$member" : null
   139        }
   140      },
   141      "NLBResource" : {
   142        "base" : "The NLB resource a DNS Target Resource points to",
   143        "refs" : {
   144          "TargetResource$NLBResource" : null
   145        }
   146      },
   147      "R53ResourceRecord" : {
   148        "base" : "The Route 53 resource a DNS Target Resource record points to",
   149        "refs" : {
   150          "TargetResource$R53Resource" : null
   151        }
   152      },
   153      "Readiness" : {
   154        "base" : "The readiness of an entire ReadinessCheck or an individual resource ARN.",
   155        "refs" : {
   156          "GetCellReadinessSummaryOutput$Readiness" : "The readiness at Cell level.",
   157          "GetReadinessCheckResourceStatusOutput$Readiness" : "The readiness at rule level.",
   158          "GetReadinessCheckStatusOutput$Readiness" : "The readiness at rule level.",
   159          "GetRecoveryGroupReadinessSummaryOutput$Readiness" : "The readiness at RecoveryGroup level.",
   160          "ReadinessCheckSummary$Readiness" : "The readiness of this ReadinessCheck",
   161          "ResourceResult$Readiness" : "The readiness of the resource.",
   162          "RuleResult$Readiness" : "The readiness at rule level."
   163        }
   164      },
   165      "ReadinessCheckCreateParameters" : {
   166        "base" : "Parameters used to create or update a ReadinessCheck",
   167        "refs" : { }
   168      },
   169      "ReadinessCheckOutput" : {
   170        "base" : "A resource used for checking the readiness of a Resource Set",
   171        "refs" : {
   172          "__listOfReadinessCheckOutput$member" : null
   173        }
   174      },
   175      "ReadinessCheckSummary" : {
   176        "base" : "Summary of ReadinessCheck status, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary",
   177        "refs" : {
   178          "__listOfReadinessCheckSummary$member" : null
   179        }
   180      },
   181      "ReadinessCheckTimestamp" : {
   182        "base" : "The time the Cell was last checked for readiness, in ISO-8601 format, UTC.",
   183        "refs" : {
   184          "ResourceResult$LastCheckedTimestamp" : "The time the resource was last checked for readiness, in ISO-8601 format, UTC.",
   185          "RuleResult$LastCheckedTimestamp" : "The time the resource was last checked for readiness, in ISO-8601 format, UTC."
   186        }
   187      },
   188      "ReadinessCheckUpdateParameters" : {
   189        "base" : "Parameters used to create or update a ReadinessCheck",
   190        "refs" : { }
   191      },
   192      "Recommendation" : {
   193        "base" : "Guidance for improving Recovery Group resilliancy",
   194        "refs" : {
   195          "__listOfRecommendation$member" : null
   196        }
   197      },
   198      "RecoveryGroupCreateParameters" : {
   199        "base" : "Parameters used to create an RecoveryGroup",
   200        "refs" : { }
   201      },
   202      "RecoveryGroupOutput" : {
   203        "base" : "A Recovery Group generally containing multiple Cells",
   204        "refs" : {
   205          "__listOfRecoveryGroupOutput$member" : null
   206        }
   207      },
   208      "RecoveryGroupUpdateParameters" : {
   209        "base" : "Parameters used to update an RecoveryGroup",
   210        "refs" : { }
   211      },
   212      "Resource" : {
   213        "base" : "The resource element of a ResourceSet",
   214        "refs" : {
   215          "__listOfResource$member" : null
   216        }
   217      },
   218      "ResourceResult" : {
   219        "base" : "Result with status for an individual resource.",
   220        "refs" : {
   221          "__listOfResourceResult$member" : null
   222        }
   223      },
   224      "ResourceSetCreateParameters" : {
   225        "base" : "Parameters used to create a ResourceSet",
   226        "refs" : { }
   227      },
   228      "ResourceSetOutput" : {
   229        "base" : "A collection of resources of the same type",
   230        "refs" : {
   231          "__listOfResourceSetOutput$member" : null
   232        }
   233      },
   234      "ResourceSetUpdateParameters" : {
   235        "base" : "Parameters used to create a ResourceSet",
   236        "refs" : { }
   237      },
   238      "RuleResult" : {
   239        "base" : "Result with status for an individual rule..",
   240        "refs" : {
   241          "__listOfRuleResult$member" : null
   242        }
   243      },
   244      "Tags" : {
   245        "base" : "A collection of tags associated with a resource",
   246        "refs" : {
   247          "CellCreateParameters$Tags" : null,
   248          "CellOutput$Tags" : null,
   249          "ReadinessCheckCreateParameters$Tags" : null,
   250          "ReadinessCheckOutput$Tags" : null,
   251          "RecoveryGroupCreateParameters$Tags" : null,
   252          "RecoveryGroupOutput$Tags" : null,
   253          "ResourceSetCreateParameters$Tags" : null,
   254          "ResourceSetOutput$Tags" : null,
   255          "TagsModel$Tags" : null
   256        }
   257      },
   258      "TagsModel" : {
   259        "base" : null,
   260        "refs" : { }
   261      },
   262      "TargetResource" : {
   263        "base" : "The target resource the R53 record points to",
   264        "refs" : {
   265          "DNSTargetResource$TargetResource" : null
   266        }
   267      },
   268      "__listOfCellOutput" : {
   269        "base" : null,
   270        "refs" : {
   271          "ListCellsResult$Cells" : "A list of Cells"
   272        }
   273      },
   274      "__listOfCrossAccountAuthorization" : {
   275        "base" : null,
   276        "refs" : {
   277          "ListCrossAccountAuthorizationsResult$CrossAccountAuthorizations" : "A list of CrossAccountAuthorizations"
   278        }
   279      },
   280      "__listOfListRulesOutput" : {
   281        "base" : null,
   282        "refs" : {
   283          "ListRulesResult$Rules" : "A list of rules"
   284        }
   285      },
   286      "__listOfMessage" : {
   287        "base" : null,
   288        "refs" : {
   289          "GetReadinessCheckStatusOutput$Messages" : "Top level messages for readiness check status",
   290          "RuleResult$Messages" : "Details about the resource's readiness"
   291        }
   292      },
   293      "__listOfReadinessCheckOutput" : {
   294        "base" : null,
   295        "refs" : {
   296          "ListReadinessChecksResult$ReadinessChecks" : "A list of ReadinessCheck associated with the account"
   297        }
   298      },
   299      "__listOfReadinessCheckSummary" : {
   300        "base" : null,
   301        "refs" : {
   302          "GetCellReadinessSummaryOutput$ReadinessChecks" : "Summaries for the ReadinessChecks making up the Cell",
   303          "GetRecoveryGroupReadinessSummaryOutput$ReadinessChecks" : "Summaries for the ReadinessChecks making up the RecoveryGroup"
   304        }
   305      },
   306      "__listOfRecommendation" : {
   307        "base" : null,
   308        "refs" : {
   309          "GetArchitectureRecommendationsOutput$Recommendations" : "A list of recommendations for the customer's application"
   310        }
   311      },
   312      "__listOfRecoveryGroupOutput" : {
   313        "base" : null,
   314        "refs" : {
   315          "ListRecoveryGroupsResult$RecoveryGroups" : "A list of RecoveryGroups"
   316        }
   317      },
   318      "__listOfResource" : {
   319        "base" : null,
   320        "refs" : {
   321          "ResourceSetCreateParameters$Resources" : "A list of Resource objects",
   322          "ResourceSetOutput$Resources" : "A list of Resource objects",
   323          "ResourceSetUpdateParameters$Resources" : "A list of Resource objects"
   324        }
   325      },
   326      "__listOfResourceResult" : {
   327        "base" : null,
   328        "refs" : {
   329          "GetReadinessCheckStatusOutput$Resources" : "Summary of resources's readiness"
   330        }
   331      },
   332      "__listOfResourceSetOutput" : {
   333        "base" : null,
   334        "refs" : {
   335          "ListResourceSetsResult$ResourceSets" : "A list of ResourceSets associated with the account"
   336        }
   337      },
   338      "__listOfRuleResult" : {
   339        "base" : null,
   340        "refs" : {
   341          "GetReadinessCheckResourceStatusOutput$Rules" : "Details of the rules's results"
   342        }
   343      },
   344      "__listOf__string" : {
   345        "base" : null,
   346        "refs" : {
   347          "CellCreateParameters$Cells" : "A list of Cell arns contained within this Cell (for use in nested Cells, e.g. regions within which AZs)",
   348          "CellOutput$Cells" : "A list of Cell arns",
   349          "CellOutput$ParentReadinessScopes" : "A list of Cell ARNs and/or RecoveryGroup ARNs",
   350          "CellUpdateParameters$Cells" : "A list of Cell arns, completely replaces previous list",
   351          "RecoveryGroupCreateParameters$Cells" : "A list of Cell arns",
   352          "RecoveryGroupOutput$Cells" : "A list of Cell arns",
   353          "RecoveryGroupUpdateParameters$Cells" : "A list of Cell arns, completely replaces previous list",
   354          "Resource$ReadinessScopes" : "A list of RecoveryGroup ARNs and/or Cell ARNs that this resource is contained within."
   355        }
   356      },
   357      "__string" : {
   358        "base" : null,
   359        "refs" : {
   360          "CellCreateParameters$CellName" : "The name of the Cell to create",
   361          "DNSTargetResource$DomainName" : "The DNS Name that acts as ingress point to a portion of application",
   362          "DNSTargetResource$HostedZoneArn" : "The Hosted Zone ARN that contains the DNS record with the provided name of target resource.",
   363          "DNSTargetResource$RecordSetId" : "The R53 Set Id to uniquely identify a record given a Name and a Type",
   364          "DNSTargetResource$RecordType" : "The Type of DNS Record of target resource",
   365          "GetArchitectureRecommendationsOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection",
   366          "GetCellReadinessSummaryOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   367          "GetReadinessCheckResourceStatusOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   368          "GetReadinessCheckStatusOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   369          "GetRecoveryGroupReadinessSummaryOutput$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   370          "ListCellsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   371          "ListCrossAccountAuthorizationsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   372          "ListReadinessChecksResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   373          "ListRecoveryGroupsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   374          "ListResourceSetsResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   375          "ListRulesResult$NextToken" : "A token that can be used to resume pagination from the end of the collection.",
   376          "Message$MessageText" : "The text of a readiness check message",
   377          "NLBResource$Arn" : "An NLB resource arn",
   378          "R53ResourceRecord$DomainName" : "The DNS target name",
   379          "R53ResourceRecord$RecordSetId" : "The Resource Record set id",
   380          "ReadinessCheckCreateParameters$ReadinessCheckName" : "The name of the ReadinessCheck to create",
   381          "ReadinessCheckCreateParameters$ResourceSetName" : "The name of the ResourceSet to check",
   382          "ReadinessCheckSummary$ReadinessCheckName" : "The name of a ReadinessCheck which is part of the given RecoveryGroup or Cell",
   383          "ReadinessCheckUpdateParameters$ResourceSetName" : "The name of the ResourceSet to check",
   384          "Recommendation$RecommendationText" : "Guidance text for recommendation",
   385          "RecoveryGroupCreateParameters$RecoveryGroupName" : "The name of the RecoveryGroup to create",
   386          "Resource$ComponentId" : "The component id of the resource, generated by the service when dnsTargetResource is used",
   387          "Resource$ResourceArn" : "The ARN of the AWS resource, can be skipped if dnsTargetResource is used",
   388          "ResourceResult$ComponentId" : "The component id of the resource",
   389          "ResourceResult$ResourceArn" : "The ARN of the resource",
   390          "ResourceSetCreateParameters$ResourceSetName" : "The name of the ResourceSet to create",
   391          "RuleResult$RuleId" : "The identifier of the rule.",
   392          "Tags$member" : null,
   393          "__listOf__string$member" : null
   394        }
   395      },
   396      "__stringMax256" : {
   397        "base" : null,
   398        "refs" : {
   399          "CellOutput$CellArn" : "The arn for the Cell",
   400          "ListRulesOutput$RuleDescription" : "A description of the rule",
   401          "ReadinessCheckOutput$ReadinessCheckArn" : "Arn associated with ReadinessCheck",
   402          "RecoveryGroupOutput$RecoveryGroupArn" : "The arn for the RecoveryGroup",
   403          "ResourceSetOutput$ResourceSetArn" : "The arn for the ResourceSet"
   404        }
   405      },
   406      "__stringMax64" : {
   407        "base" : null,
   408        "refs" : {
   409          "ListRulesOutput$ResourceType" : "The resource type the rule applies to.",
   410          "ListRulesOutput$RuleId" : "The Rule's ID."
   411        }
   412      },
   413      "__stringMax64PatternAAZAZ09Z" : {
   414        "base" : null,
   415        "refs" : {
   416          "CellOutput$CellName" : "The name of the Cell",
   417          "ReadinessCheckOutput$ReadinessCheckName" : "Name for a ReadinessCheck",
   418          "ReadinessCheckOutput$ResourceSet" : "Name of the ResourceSet to be checked",
   419          "RecoveryGroupOutput$RecoveryGroupName" : "The name of the RecoveryGroup",
   420          "ResourceSetOutput$ResourceSetName" : "The name of the ResourceSet"
   421        }
   422      },
   423      "__stringPatternAWSAZaZ09AZaZ09" : {
   424        "base" : null,
   425        "refs" : {
   426          "ResourceSetCreateParameters$ResourceSetType" : "AWS Resource type of the resources in the ResourceSet",
   427          "ResourceSetOutput$ResourceSetType" : "AWS Resource Type of the resources in the ResourceSet",
   428          "ResourceSetUpdateParameters$ResourceSetType" : "AWS Resource Type of the resources in the ResourceSet"
   429        }
   430      }
   431    }
   432  }