github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/marketplace-catalog/2018-09-17/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2018-09-17",
     5      "endpointPrefix":"catalog.marketplace",
     6      "jsonVersion":"1.1",
     7      "protocol":"rest-json",
     8      "serviceAbbreviation":"AWS Marketplace Catalog",
     9      "serviceFullName":"AWS Marketplace Catalog Service",
    10      "serviceId":"Marketplace Catalog",
    11      "signatureVersion":"v4",
    12      "signingName":"aws-marketplace",
    13      "uid":"marketplace-catalog-2018-09-17"
    14    },
    15    "operations":{
    16      "CancelChangeSet":{
    17        "name":"CancelChangeSet",
    18        "http":{
    19          "method":"PATCH",
    20          "requestUri":"/CancelChangeSet"
    21        },
    22        "input":{"shape":"CancelChangeSetRequest"},
    23        "output":{"shape":"CancelChangeSetResponse"},
    24        "errors":[
    25          {"shape":"InternalServiceException"},
    26          {"shape":"AccessDeniedException"},
    27          {"shape":"ValidationException"},
    28          {"shape":"ResourceNotFoundException"},
    29          {"shape":"ResourceInUseException"},
    30          {"shape":"ThrottlingException"}
    31        ]
    32      },
    33      "DescribeChangeSet":{
    34        "name":"DescribeChangeSet",
    35        "http":{
    36          "method":"GET",
    37          "requestUri":"/DescribeChangeSet"
    38        },
    39        "input":{"shape":"DescribeChangeSetRequest"},
    40        "output":{"shape":"DescribeChangeSetResponse"},
    41        "errors":[
    42          {"shape":"InternalServiceException"},
    43          {"shape":"AccessDeniedException"},
    44          {"shape":"ValidationException"},
    45          {"shape":"ResourceNotFoundException"},
    46          {"shape":"ThrottlingException"}
    47        ]
    48      },
    49      "DescribeEntity":{
    50        "name":"DescribeEntity",
    51        "http":{
    52          "method":"GET",
    53          "requestUri":"/DescribeEntity"
    54        },
    55        "input":{"shape":"DescribeEntityRequest"},
    56        "output":{"shape":"DescribeEntityResponse"},
    57        "errors":[
    58          {"shape":"InternalServiceException"},
    59          {"shape":"AccessDeniedException"},
    60          {"shape":"ValidationException"},
    61          {"shape":"ResourceNotSupportedException"},
    62          {"shape":"ResourceNotFoundException"},
    63          {"shape":"ThrottlingException"}
    64        ]
    65      },
    66      "ListChangeSets":{
    67        "name":"ListChangeSets",
    68        "http":{
    69          "method":"POST",
    70          "requestUri":"/ListChangeSets"
    71        },
    72        "input":{"shape":"ListChangeSetsRequest"},
    73        "output":{"shape":"ListChangeSetsResponse"},
    74        "errors":[
    75          {"shape":"InternalServiceException"},
    76          {"shape":"AccessDeniedException"},
    77          {"shape":"ValidationException"},
    78          {"shape":"ThrottlingException"}
    79        ]
    80      },
    81      "ListEntities":{
    82        "name":"ListEntities",
    83        "http":{
    84          "method":"POST",
    85          "requestUri":"/ListEntities"
    86        },
    87        "input":{"shape":"ListEntitiesRequest"},
    88        "output":{"shape":"ListEntitiesResponse"},
    89        "errors":[
    90          {"shape":"InternalServiceException"},
    91          {"shape":"AccessDeniedException"},
    92          {"shape":"ValidationException"},
    93          {"shape":"ResourceNotFoundException"},
    94          {"shape":"ThrottlingException"}
    95        ]
    96      },
    97      "StartChangeSet":{
    98        "name":"StartChangeSet",
    99        "http":{
   100          "method":"POST",
   101          "requestUri":"/StartChangeSet"
   102        },
   103        "input":{"shape":"StartChangeSetRequest"},
   104        "output":{"shape":"StartChangeSetResponse"},
   105        "errors":[
   106          {"shape":"InternalServiceException"},
   107          {"shape":"AccessDeniedException"},
   108          {"shape":"ValidationException"},
   109          {"shape":"ResourceNotFoundException"},
   110          {"shape":"ResourceInUseException"},
   111          {"shape":"ThrottlingException"},
   112          {"shape":"ServiceQuotaExceededException"}
   113        ]
   114      }
   115    },
   116    "shapes":{
   117      "ARN":{
   118        "type":"string",
   119        "max":2048,
   120        "min":1,
   121        "pattern":"^[a-zA-Z0-9:*/-]+$"
   122      },
   123      "AccessDeniedException":{
   124        "type":"structure",
   125        "members":{
   126          "Message":{"shape":"ExceptionMessageContent"}
   127        },
   128        "error":{"httpStatusCode":403},
   129        "exception":true,
   130        "synthetic":true
   131      },
   132      "CancelChangeSetRequest":{
   133        "type":"structure",
   134        "required":[
   135          "Catalog",
   136          "ChangeSetId"
   137        ],
   138        "members":{
   139          "Catalog":{
   140            "shape":"Catalog",
   141            "location":"querystring",
   142            "locationName":"catalog"
   143          },
   144          "ChangeSetId":{
   145            "shape":"ResourceId",
   146            "location":"querystring",
   147            "locationName":"changeSetId"
   148          }
   149        }
   150      },
   151      "CancelChangeSetResponse":{
   152        "type":"structure",
   153        "members":{
   154          "ChangeSetId":{"shape":"ResourceId"},
   155          "ChangeSetArn":{"shape":"ARN"}
   156        }
   157      },
   158      "Catalog":{
   159        "type":"string",
   160        "max":64,
   161        "min":1,
   162        "pattern":"^[a-zA-Z]+$"
   163      },
   164      "Change":{
   165        "type":"structure",
   166        "required":[
   167          "ChangeType",
   168          "Entity",
   169          "Details"
   170        ],
   171        "members":{
   172          "ChangeType":{"shape":"ChangeType"},
   173          "Entity":{"shape":"Entity"},
   174          "Details":{"shape":"Json"},
   175          "ChangeName":{"shape":"ChangeName"}
   176        }
   177      },
   178      "ChangeName":{
   179        "type":"string",
   180        "max":72,
   181        "min":1,
   182        "pattern":"^[a-zA-Z]$"
   183      },
   184      "ChangeSetDescription":{
   185        "type":"list",
   186        "member":{"shape":"ChangeSummary"}
   187      },
   188      "ChangeSetName":{
   189        "type":"string",
   190        "max":100,
   191        "min":1,
   192        "pattern":"^[\\w\\s+=.:@-]+$"
   193      },
   194      "ChangeSetSummaryList":{
   195        "type":"list",
   196        "member":{"shape":"ChangeSetSummaryListItem"}
   197      },
   198      "ChangeSetSummaryListItem":{
   199        "type":"structure",
   200        "members":{
   201          "ChangeSetId":{"shape":"ResourceId"},
   202          "ChangeSetArn":{"shape":"ARN"},
   203          "ChangeSetName":{"shape":"ChangeSetName"},
   204          "StartTime":{"shape":"DateTimeISO8601"},
   205          "EndTime":{"shape":"DateTimeISO8601"},
   206          "Status":{"shape":"ChangeStatus"},
   207          "EntityIdList":{"shape":"ResourceIdList"},
   208          "FailureCode":{"shape":"FailureCode"}
   209        }
   210      },
   211      "ChangeStatus":{
   212        "type":"string",
   213        "enum":[
   214          "PREPARING",
   215          "APPLYING",
   216          "SUCCEEDED",
   217          "CANCELLED",
   218          "FAILED"
   219        ]
   220      },
   221      "ChangeSummary":{
   222        "type":"structure",
   223        "members":{
   224          "ChangeType":{"shape":"ChangeType"},
   225          "Entity":{"shape":"Entity"},
   226          "Details":{"shape":"Json"},
   227          "ErrorDetailList":{"shape":"ErrorDetailList"},
   228          "ChangeName":{"shape":"ChangeName"}
   229        }
   230      },
   231      "ChangeType":{
   232        "type":"string",
   233        "max":255,
   234        "min":1,
   235        "pattern":"^[A-Z][\\w]*$"
   236      },
   237      "ClientRequestToken":{
   238        "type":"string",
   239        "max":36,
   240        "min":1,
   241        "pattern":"^[\\w\\-]+$"
   242      },
   243      "DateTimeISO8601":{
   244        "type":"string",
   245        "max":20,
   246        "min":20,
   247        "pattern":"^([\\d]{4})\\-(1[0-2]|0[1-9])\\-(3[01]|0[1-9]|[12][\\d])T(2[0-3]|[01][\\d]):([0-5][\\d]):([0-5][\\d])Z$"
   248      },
   249      "DescribeChangeSetRequest":{
   250        "type":"structure",
   251        "required":[
   252          "Catalog",
   253          "ChangeSetId"
   254        ],
   255        "members":{
   256          "Catalog":{
   257            "shape":"Catalog",
   258            "location":"querystring",
   259            "locationName":"catalog"
   260          },
   261          "ChangeSetId":{
   262            "shape":"ResourceId",
   263            "location":"querystring",
   264            "locationName":"changeSetId"
   265          }
   266        }
   267      },
   268      "DescribeChangeSetResponse":{
   269        "type":"structure",
   270        "members":{
   271          "ChangeSetId":{"shape":"ResourceId"},
   272          "ChangeSetArn":{"shape":"ARN"},
   273          "ChangeSetName":{"shape":"ChangeSetName"},
   274          "StartTime":{"shape":"DateTimeISO8601"},
   275          "EndTime":{"shape":"DateTimeISO8601"},
   276          "Status":{"shape":"ChangeStatus"},
   277          "FailureCode":{"shape":"FailureCode"},
   278          "FailureDescription":{"shape":"ExceptionMessageContent"},
   279          "ChangeSet":{"shape":"ChangeSetDescription"}
   280        }
   281      },
   282      "DescribeEntityRequest":{
   283        "type":"structure",
   284        "required":[
   285          "Catalog",
   286          "EntityId"
   287        ],
   288        "members":{
   289          "Catalog":{
   290            "shape":"Catalog",
   291            "location":"querystring",
   292            "locationName":"catalog"
   293          },
   294          "EntityId":{
   295            "shape":"ResourceId",
   296            "location":"querystring",
   297            "locationName":"entityId"
   298          }
   299        }
   300      },
   301      "DescribeEntityResponse":{
   302        "type":"structure",
   303        "members":{
   304          "EntityType":{"shape":"EntityType"},
   305          "EntityIdentifier":{"shape":"Identifier"},
   306          "EntityArn":{"shape":"ARN"},
   307          "LastModifiedDate":{"shape":"DateTimeISO8601"},
   308          "Details":{"shape":"Json"}
   309        }
   310      },
   311      "Entity":{
   312        "type":"structure",
   313        "required":["Type"],
   314        "members":{
   315          "Type":{"shape":"EntityType"},
   316          "Identifier":{"shape":"Identifier"}
   317        }
   318      },
   319      "EntityNameString":{
   320        "type":"string",
   321        "max":255,
   322        "min":1,
   323        "pattern":"^\\\\S+[\\\\S\\\\s]*"
   324      },
   325      "EntitySummary":{
   326        "type":"structure",
   327        "members":{
   328          "Name":{"shape":"EntityNameString"},
   329          "EntityType":{"shape":"EntityType"},
   330          "EntityId":{"shape":"ResourceId"},
   331          "EntityArn":{"shape":"ARN"},
   332          "LastModifiedDate":{"shape":"DateTimeISO8601"},
   333          "Visibility":{"shape":"VisibilityValue"}
   334        }
   335      },
   336      "EntitySummaryList":{
   337        "type":"list",
   338        "member":{"shape":"EntitySummary"}
   339      },
   340      "EntityType":{
   341        "type":"string",
   342        "max":255,
   343        "min":1,
   344        "pattern":"^[a-zA-Z]+$"
   345      },
   346      "ErrorCodeString":{
   347        "type":"string",
   348        "max":72,
   349        "min":1,
   350        "pattern":"^[a-zA-Z_]+$"
   351      },
   352      "ErrorDetail":{
   353        "type":"structure",
   354        "members":{
   355          "ErrorCode":{"shape":"ErrorCodeString"},
   356          "ErrorMessage":{"shape":"ExceptionMessageContent"}
   357        }
   358      },
   359      "ErrorDetailList":{
   360        "type":"list",
   361        "member":{"shape":"ErrorDetail"}
   362      },
   363      "ExceptionMessageContent":{
   364        "type":"string",
   365        "max":2048,
   366        "min":1,
   367        "pattern":"^(.)+$"
   368      },
   369      "FailureCode":{
   370        "type":"string",
   371        "enum":[
   372          "CLIENT_ERROR",
   373          "SERVER_FAULT"
   374        ]
   375      },
   376      "Filter":{
   377        "type":"structure",
   378        "members":{
   379          "Name":{"shape":"FilterName"},
   380          "ValueList":{"shape":"ValueList"}
   381        }
   382      },
   383      "FilterList":{
   384        "type":"list",
   385        "member":{"shape":"Filter"},
   386        "max":8,
   387        "min":1
   388      },
   389      "FilterName":{
   390        "type":"string",
   391        "max":255,
   392        "min":1,
   393        "pattern":"^[a-zA-Z]+$"
   394      },
   395      "FilterValueContent":{
   396        "type":"string",
   397        "max":255,
   398        "min":1,
   399        "pattern":"^(.)+$"
   400      },
   401      "Identifier":{
   402        "type":"string",
   403        "max":255,
   404        "min":1,
   405        "pattern":"^[\\w\\-@]+$"
   406      },
   407      "InternalServiceException":{
   408        "type":"structure",
   409        "members":{
   410          "Message":{"shape":"ExceptionMessageContent"}
   411        },
   412        "error":{"httpStatusCode":500},
   413        "exception":true,
   414        "synthetic":true
   415      },
   416      "Json":{
   417        "type":"string",
   418        "max":16384,
   419        "min":2,
   420        "pattern":"^[\\s]*\\{[\\s\\S]*\\}[\\s]*$"
   421      },
   422      "ListChangeSetsRequest":{
   423        "type":"structure",
   424        "required":["Catalog"],
   425        "members":{
   426          "Catalog":{"shape":"Catalog"},
   427          "FilterList":{"shape":"FilterList"},
   428          "Sort":{"shape":"Sort"},
   429          "MaxResults":{"shape":"MaxResultInteger"},
   430          "NextToken":{"shape":"NextToken"}
   431        }
   432      },
   433      "ListChangeSetsResponse":{
   434        "type":"structure",
   435        "members":{
   436          "ChangeSetSummaryList":{"shape":"ChangeSetSummaryList"},
   437          "NextToken":{"shape":"NextToken"}
   438        }
   439      },
   440      "ListEntitiesRequest":{
   441        "type":"structure",
   442        "required":[
   443          "Catalog",
   444          "EntityType"
   445        ],
   446        "members":{
   447          "Catalog":{"shape":"Catalog"},
   448          "EntityType":{"shape":"EntityType"},
   449          "FilterList":{"shape":"FilterList"},
   450          "Sort":{"shape":"Sort"},
   451          "NextToken":{"shape":"NextToken"},
   452          "MaxResults":{"shape":"MaxResultInteger"}
   453        }
   454      },
   455      "ListEntitiesResponse":{
   456        "type":"structure",
   457        "members":{
   458          "EntitySummaryList":{"shape":"EntitySummaryList"},
   459          "NextToken":{"shape":"NextToken"}
   460        }
   461      },
   462      "MaxResultInteger":{
   463        "type":"integer",
   464        "box":true,
   465        "max":20,
   466        "min":1
   467      },
   468      "NextToken":{
   469        "type":"string",
   470        "max":2048,
   471        "min":1,
   472        "pattern":"^[\\w+=.:@\\-\\/]$"
   473      },
   474      "RequestedChangeList":{
   475        "type":"list",
   476        "member":{"shape":"Change"},
   477        "max":20,
   478        "min":1
   479      },
   480      "ResourceId":{
   481        "type":"string",
   482        "max":255,
   483        "min":1,
   484        "pattern":"^[\\w\\-]+$"
   485      },
   486      "ResourceIdList":{
   487        "type":"list",
   488        "member":{"shape":"ResourceId"}
   489      },
   490      "ResourceInUseException":{
   491        "type":"structure",
   492        "members":{
   493          "Message":{"shape":"ExceptionMessageContent"}
   494        },
   495        "error":{"httpStatusCode":423},
   496        "exception":true,
   497        "synthetic":true
   498      },
   499      "ResourceNotFoundException":{
   500        "type":"structure",
   501        "members":{
   502          "Message":{"shape":"ExceptionMessageContent"}
   503        },
   504        "error":{"httpStatusCode":404},
   505        "exception":true,
   506        "synthetic":true
   507      },
   508      "ResourceNotSupportedException":{
   509        "type":"structure",
   510        "members":{
   511          "Message":{"shape":"ExceptionMessageContent"}
   512        },
   513        "error":{"httpStatusCode":415},
   514        "exception":true,
   515        "synthetic":true
   516      },
   517      "ServiceQuotaExceededException":{
   518        "type":"structure",
   519        "members":{
   520          "Message":{"shape":"ExceptionMessageContent"}
   521        },
   522        "error":{"httpStatusCode":402},
   523        "exception":true,
   524        "synthetic":true
   525      },
   526      "Sort":{
   527        "type":"structure",
   528        "members":{
   529          "SortBy":{"shape":"SortBy"},
   530          "SortOrder":{"shape":"SortOrder"}
   531        }
   532      },
   533      "SortBy":{
   534        "type":"string",
   535        "max":255,
   536        "min":1,
   537        "pattern":"^[a-zA-Z]+$"
   538      },
   539      "SortOrder":{
   540        "type":"string",
   541        "enum":[
   542          "ASCENDING",
   543          "DESCENDING"
   544        ]
   545      },
   546      "StartChangeSetRequest":{
   547        "type":"structure",
   548        "required":[
   549          "Catalog",
   550          "ChangeSet"
   551        ],
   552        "members":{
   553          "Catalog":{"shape":"Catalog"},
   554          "ChangeSet":{"shape":"RequestedChangeList"},
   555          "ChangeSetName":{"shape":"ChangeSetName"},
   556          "ClientRequestToken":{"shape":"ClientRequestToken"}
   557        }
   558      },
   559      "StartChangeSetResponse":{
   560        "type":"structure",
   561        "members":{
   562          "ChangeSetId":{"shape":"ResourceId"},
   563          "ChangeSetArn":{"shape":"ARN"}
   564        }
   565      },
   566      "ThrottlingException":{
   567        "type":"structure",
   568        "members":{
   569          "Message":{"shape":"ExceptionMessageContent"}
   570        },
   571        "error":{"httpStatusCode":429},
   572        "exception":true,
   573        "synthetic":true
   574      },
   575      "ValidationException":{
   576        "type":"structure",
   577        "members":{
   578          "Message":{"shape":"ExceptionMessageContent"}
   579        },
   580        "error":{"httpStatusCode":422},
   581        "exception":true,
   582        "synthetic":true
   583      },
   584      "ValueList":{
   585        "type":"list",
   586        "member":{"shape":"FilterValueContent"},
   587        "max":10,
   588        "min":1
   589      },
   590      "VisibilityValue":{
   591        "type":"string",
   592        "max":64,
   593        "min":1,
   594        "pattern":"^[a-zA-Z]+$"
   595      }
   596    }
   597  }