codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of amp Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2020-08-01",
"endpointPrefix":"aps",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"Amazon Prometheus Service",
"serviceId":"amp",
"signatureVersion":"v4",
"signingName":"aps",
"uid":"amp-2020-08-01"
},
"operations":{
"CreateWorkspace":{
"name":"CreateWorkspace",
"http":{
"method":"POST",
"requestUri":"/workspaces",
"responseCode":202
},
"input":{"shape":"CreateWorkspaceRequest"},
"output":{"shape":"CreateWorkspaceResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServerException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"Creates a new AMP workspace.
",
"idempotent":true
},
"DeleteWorkspace":{
"name":"DeleteWorkspace",
"http":{
"method":"DELETE",
"requestUri":"/workspaces/{workspaceId}",
"responseCode":202
},
"input":{"shape":"DeleteWorkspaceRequest"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServerException"}
],
"documentation":"Deletes an AMP workspace.
",
"idempotent":true
},
"DescribeWorkspace":{
"name":"DescribeWorkspace",
"http":{
"method":"GET",
"requestUri":"/workspaces/{workspaceId}",
"responseCode":200
},
"input":{"shape":"DescribeWorkspaceRequest"},
"output":{"shape":"DescribeWorkspaceResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServerException"}
],
"documentation":"Describes an existing AMP workspace.
"
},
"ListWorkspaces":{
"name":"ListWorkspaces",
"http":{
"method":"GET",
"requestUri":"/workspaces",
"responseCode":200
},
"input":{"shape":"ListWorkspacesRequest"},
"output":{"shape":"ListWorkspacesResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServerException"}
],
"documentation":"Lists all AMP workspaces, including workspaces being created or deleted.
"
},
"UpdateWorkspaceAlias":{
"name":"UpdateWorkspaceAlias",
"http":{
"method":"POST",
"requestUri":"/workspaces/{workspaceId}/alias",
"responseCode":204
},
"input":{"shape":"UpdateWorkspaceAliasRequest"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServerException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"Updates an AMP workspace alias.
",
"idempotent":true
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"required":["message"],
"members":{
"message":{
"shape":"String",
"documentation":"Description of the error.
"
}
},
"documentation":"User does not have sufficient access to perform this action.
",
"error":{
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"ConflictException":{
"type":"structure",
"required":[
"message",
"resourceId",
"resourceType"
],
"members":{
"message":{
"shape":"String",
"documentation":"Description of the error.
"
},
"resourceId":{
"shape":"String",
"documentation":"Identifier of the resource affected.
"
},
"resourceType":{
"shape":"String",
"documentation":"Type of the resource affected.
"
}
},
"documentation":"Updating or deleting a resource can cause an inconsistent state.
",
"error":{
"httpStatusCode":409,
"senderFault":true
},
"exception":true
},
"CreateWorkspaceRequest":{
"type":"structure",
"members":{
"alias":{
"shape":"WorkspaceAlias",
"documentation":"An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.
"
},
"clientToken":{
"shape":"IdempotencyToken",
"documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
",
"idempotencyToken":true
}
},
"documentation":"Represents the input of a CreateWorkspace operation.
"
},
"CreateWorkspaceResponse":{
"type":"structure",
"required":[
"arn",
"status",
"workspaceId"
],
"members":{
"arn":{
"shape":"WorkspaceArn",
"documentation":"The ARN of the workspace that was just created.
"
},
"status":{
"shape":"WorkspaceStatus",
"documentation":"The status of the workspace that was just created (usually CREATING).
"
},
"workspaceId":{
"shape":"WorkspaceId",
"documentation":"The generated ID of the workspace that was just created.
"
}
},
"documentation":"Represents the output of a CreateWorkspace operation.
"
},
"DeleteWorkspaceRequest":{
"type":"structure",
"required":["workspaceId"],
"members":{
"clientToken":{
"shape":"IdempotencyToken",
"documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"workspaceId":{
"shape":"WorkspaceId",
"documentation":"The ID of the workspace to delete.
",
"location":"uri",
"locationName":"workspaceId"
}
},
"documentation":"Represents the input of a DeleteWorkspace operation.
"
},
"DescribeWorkspaceRequest":{
"type":"structure",
"required":["workspaceId"],
"members":{
"workspaceId":{
"shape":"WorkspaceId",
"documentation":"The ID of the workspace to describe.
",
"location":"uri",
"locationName":"workspaceId"
}
},
"documentation":"Represents the input of a DescribeWorkspace operation.
"
},
"DescribeWorkspaceResponse":{
"type":"structure",
"required":["workspace"],
"members":{
"workspace":{
"shape":"WorkspaceDescription",
"documentation":"The properties of the selected workspace.
"
}
},
"documentation":"Represents the output of a DescribeWorkspace operation.
"
},
"IdempotencyToken":{
"type":"string",
"documentation":"An identifier used to ensure the idempotency of a write request.
",
"max":64,
"min":1,
"pattern":"[!-~]+"
},
"Integer":{
"type":"integer",
"box":true
},
"InternalServerException":{
"type":"structure",
"required":["message"],
"members":{
"message":{
"shape":"String",
"documentation":"Description of the error.
"
},
"retryAfterSeconds":{
"shape":"Integer",
"documentation":"Advice to clients on when the call can be safely retried.
",
"location":"header",
"locationName":"Retry-After"
}
},
"documentation":"Unexpected error during processing of request.
",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"retryable":{"throttling":false}
},
"ListWorkspacesRequest":{
"type":"structure",
"members":{
"alias":{
"shape":"WorkspaceAlias",
"documentation":"Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
",
"location":"querystring",
"locationName":"alias"
},
"maxResults":{
"shape":"ListWorkspacesRequestMaxResultsInteger",
"documentation":"Maximum results to return in response (default=100, maximum=1000).
",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"Represents the input of a ListWorkspaces operation.
"
},
"ListWorkspacesRequestMaxResultsInteger":{
"type":"integer",
"box":true,
"max":1000,
"min":1
},
"ListWorkspacesResponse":{
"type":"structure",
"required":["workspaces"],
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"Pagination token to use when requesting the next page in this list.
"
},
"workspaces":{
"shape":"WorkspaceSummaryList",
"documentation":"The list of existing workspaces, including those undergoing creation or deletion.
"
}
},
"documentation":"Represents the output of a ListWorkspaces operation.
"
},
"PaginationToken":{
"type":"string",
"documentation":"A token used to access the next page in a paginated result set.
"
},
"ResourceNotFoundException":{
"type":"structure",
"required":[
"message",
"resourceId",
"resourceType"
],
"members":{
"message":{
"shape":"String",
"documentation":"Description of the error.
"
},
"resourceId":{
"shape":"String",
"documentation":"Identifier of the resource affected.
"
},
"resourceType":{
"shape":"String",
"documentation":"Type of the resource affected.
"
}
},
"documentation":"Request references a resource which does not exist.
",
"error":{
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ServiceQuotaExceededException":{
"type":"structure",
"required":[
"message",
"quotaCode",
"resourceId",
"resourceType",
"serviceCode"
],
"members":{
"message":{
"shape":"String",
"documentation":"Description of the error.
"
},
"quotaCode":{
"shape":"String",
"documentation":"Service Quotas requirement to identify originating quota.
"
},
"resourceId":{
"shape":"String",
"documentation":"Identifier of the resource affected.
"
},
"resourceType":{
"shape":"String",
"documentation":"Type of the resource affected.
"
},
"serviceCode":{
"shape":"String",
"documentation":"Service Quotas requirement to identify originating service.
"
}
},
"documentation":"Request would cause a service quota to be exceeded.
",
"error":{
"httpStatusCode":402,
"senderFault":true
},
"exception":true
},
"String":{"type":"string"},
"ThrottlingException":{
"type":"structure",
"required":["message"],
"members":{
"message":{
"shape":"String",
"documentation":"Description of the error.
"
},
"quotaCode":{
"shape":"String",
"documentation":"Service Quotas requirement to identify originating quota.
"
},
"retryAfterSeconds":{
"shape":"Integer",
"documentation":"Advice to clients on when the call can be safely retried.
",
"location":"header",
"locationName":"Retry-After"
},
"serviceCode":{
"shape":"String",
"documentation":"Service Quotas requirement to identify originating service.
"
}
},
"documentation":"Request was denied due to request throttling.
",
"error":{
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"retryable":{"throttling":false}
},
"Timestamp":{"type":"timestamp"},
"UpdateWorkspaceAliasRequest":{
"type":"structure",
"required":["workspaceId"],
"members":{
"alias":{
"shape":"WorkspaceAlias",
"documentation":"The new alias of the workspace.
"
},
"clientToken":{
"shape":"IdempotencyToken",
"documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
",
"idempotencyToken":true
},
"workspaceId":{
"shape":"WorkspaceId",
"documentation":"The ID of the workspace being updated.
",
"location":"uri",
"locationName":"workspaceId"
}
},
"documentation":"Represents the input of an UpdateWorkspaceAlias operation.
"
},
"Uri":{
"type":"string",
"max":1024,
"min":1
},
"ValidationException":{
"type":"structure",
"required":[
"message",
"reason"
],
"members":{
"fieldList":{
"shape":"ValidationExceptionFieldList",
"documentation":"The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.
"
},
"message":{
"shape":"String",
"documentation":"Description of the error.
"
},
"reason":{
"shape":"ValidationExceptionReason",
"documentation":"Reason the request failed validation.
"
}
},
"documentation":"The input fails to satisfy the constraints specified by an AWS service.
",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ValidationExceptionField":{
"type":"structure",
"required":[
"message",
"name"
],
"members":{
"message":{
"shape":"String",
"documentation":"Message describing why the field failed validation.
"
},
"name":{
"shape":"String",
"documentation":"The field name.
"
}
},
"documentation":"Stores information about a field passed inside a request that resulted in an exception.
"
},
"ValidationExceptionFieldList":{
"type":"list",
"member":{"shape":"ValidationExceptionField"},
"documentation":"A list of fields.
"
},
"ValidationExceptionReason":{
"type":"string",
"documentation":"Possible reasons a request failed validation.
",
"enum":[
"UNKNOWN_OPERATION",
"CANNOT_PARSE",
"FIELD_VALIDATION_FAILED",
"OTHER"
]
},
"WorkspaceAlias":{
"type":"string",
"documentation":"A user-assigned workspace alias.
",
"max":100,
"min":1
},
"WorkspaceArn":{
"type":"string",
"documentation":"An ARN identifying a Workspace.
"
},
"WorkspaceDescription":{
"type":"structure",
"required":[
"arn",
"createdAt",
"status",
"workspaceId"
],
"members":{
"alias":{
"shape":"WorkspaceAlias",
"documentation":"Alias of this workspace.
"
},
"arn":{
"shape":"WorkspaceArn",
"documentation":"The Amazon Resource Name (ARN) of this workspace.
"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"The time when the workspace was created.
"
},
"prometheusEndpoint":{
"shape":"Uri",
"documentation":"Prometheus endpoint URI.
"
},
"status":{
"shape":"WorkspaceStatus",
"documentation":"The status of this workspace.
"
},
"workspaceId":{
"shape":"WorkspaceId",
"documentation":"Unique string identifying this workspace.
"
}
},
"documentation":"Represents the properties of a workspace.
"
},
"WorkspaceId":{
"type":"string",
"documentation":"A workspace ID.
",
"max":64,
"min":1,
"pattern":"[0-9A-Za-z][-.0-9A-Z_a-z]*"
},
"WorkspaceStatus":{
"type":"structure",
"required":["statusCode"],
"members":{
"statusCode":{
"shape":"WorkspaceStatusCode",
"documentation":"Status code of this workspace.
"
}
},
"documentation":"Represents the status of a workspace.
"
},
"WorkspaceStatusCode":{
"type":"string",
"documentation":"State of a workspace.
",
"enum":[
"CREATING",
"ACTIVE",
"UPDATING",
"DELETING",
"CREATION_FAILED"
]
},
"WorkspaceSummary":{
"type":"structure",
"required":[
"arn",
"createdAt",
"status",
"workspaceId"
],
"members":{
"alias":{
"shape":"WorkspaceAlias",
"documentation":"Alias of this workspace.
"
},
"arn":{
"shape":"WorkspaceArn",
"documentation":"The AmazonResourceName of this workspace.
"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"The time when the workspace was created.
"
},
"status":{
"shape":"WorkspaceStatus",
"documentation":"The status of this workspace.
"
},
"workspaceId":{
"shape":"WorkspaceId",
"documentation":"Unique string identifying this workspace.
"
}
},
"documentation":"Represents a summary of the properties of a workspace.
"
},
"WorkspaceSummaryList":{
"type":"list",
"member":{"shape":"WorkspaceSummary"},
"documentation":"A list of workspace summaries.
"
}
},
"documentation":"Amazon Managed Service for Prometheus
"
}