{ "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":{ "CreateAlertManagerDefinition":{ "name":"CreateAlertManagerDefinition", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/alertmanager/definition", "responseCode":202 }, "input":{"shape":"CreateAlertManagerDefinitionRequest"}, "output":{"shape":"CreateAlertManagerDefinitionResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"
Create an alert manager definition.
", "idempotent":true }, "CreateRuleGroupsNamespace":{ "name":"CreateRuleGroupsNamespace", "http":{ "method":"POST", "requestUri":"/workspaces/{workspaceId}/rulegroupsnamespaces", "responseCode":202 }, "input":{"shape":"CreateRuleGroupsNamespaceRequest"}, "output":{"shape":"CreateRuleGroupsNamespaceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Create a rule group namespace.
", "idempotent":true }, "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 }, "DeleteAlertManagerDefinition":{ "name":"DeleteAlertManagerDefinition", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}/alertmanager/definition", "responseCode":202 }, "input":{"shape":"DeleteAlertManagerDefinitionRequest"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes an alert manager definition.
", "idempotent":true }, "DeleteRuleGroupsNamespace":{ "name":"DeleteRuleGroupsNamespace", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", "responseCode":202 }, "input":{"shape":"DeleteRuleGroupsNamespaceRequest"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Delete a rule groups namespace.
", "idempotent":true }, "DeleteWorkspace":{ "name":"DeleteWorkspace", "http":{ "method":"DELETE", "requestUri":"/workspaces/{workspaceId}", "responseCode":202 }, "input":{"shape":"DeleteWorkspaceRequest"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes an AMP workspace.
", "idempotent":true }, "DescribeAlertManagerDefinition":{ "name":"DescribeAlertManagerDefinition", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceId}/alertmanager/definition", "responseCode":200 }, "input":{"shape":"DescribeAlertManagerDefinitionRequest"}, "output":{"shape":"DescribeAlertManagerDefinitionResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Describes an alert manager definition.
" }, "DescribeRuleGroupsNamespace":{ "name":"DescribeRuleGroupsNamespace", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", "responseCode":200 }, "input":{"shape":"DescribeRuleGroupsNamespaceRequest"}, "output":{"shape":"DescribeRuleGroupsNamespaceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Describe a rule groups namespace.
" }, "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.
" }, "ListRuleGroupsNamespaces":{ "name":"ListRuleGroupsNamespaces", "http":{ "method":"GET", "requestUri":"/workspaces/{workspaceId}/rulegroupsnamespaces", "responseCode":200 }, "input":{"shape":"ListRuleGroupsNamespacesRequest"}, "output":{"shape":"ListRuleGroupsNamespacesResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Lists rule groups namespaces.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the tags you have assigned to the resource.
" }, "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.
" }, "PutAlertManagerDefinition":{ "name":"PutAlertManagerDefinition", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceId}/alertmanager/definition", "responseCode":202 }, "input":{"shape":"PutAlertManagerDefinitionRequest"}, "output":{"shape":"PutAlertManagerDefinitionResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Update an alert manager definition.
", "idempotent":true }, "PutRuleGroupsNamespace":{ "name":"PutRuleGroupsNamespace", "http":{ "method":"PUT", "requestUri":"/workspaces/{workspaceId}/rulegroupsnamespaces/{name}", "responseCode":202 }, "input":{"shape":"PutRuleGroupsNamespaceRequest"}, "output":{"shape":"PutRuleGroupsNamespaceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"Update a rule groups namespace.
", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Creates tags for the specified resource.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes tags from the specified resource.
", "idempotent":true }, "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 }, "AlertManagerDefinitionData":{ "type":"blob", "documentation":"The alert manager definition data.
" }, "AlertManagerDefinitionDescription":{ "type":"structure", "required":[ "createdAt", "data", "modifiedAt", "status" ], "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"The time when the alert manager definition was created.
" }, "data":{ "shape":"AlertManagerDefinitionData", "documentation":"The alert manager definition.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The time when the alert manager definition was modified.
" }, "status":{ "shape":"AlertManagerDefinitionStatus", "documentation":"The status of alert manager definition.
" } }, "documentation":"Represents the properties of an alert manager definition.
" }, "AlertManagerDefinitionStatus":{ "type":"structure", "required":["statusCode"], "members":{ "statusCode":{ "shape":"AlertManagerDefinitionStatusCode", "documentation":"Status code of this definition.
" }, "statusReason":{ "shape":"String", "documentation":"The reason for failure if any.
" } }, "documentation":"Represents the status of a definition.
" }, "AlertManagerDefinitionStatusCode":{ "type":"string", "documentation":"State of an alert manager definition.
", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" ] }, "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 }, "CreateAlertManagerDefinitionRequest":{ "type":"structure", "required":[ "data", "workspaceId" ], "members":{ "clientToken":{ "shape":"IdempotencyToken", "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", "idempotencyToken":true }, "data":{ "shape":"AlertManagerDefinitionData", "documentation":"The alert manager definition data.
" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The ID of the workspace in which to create the alert manager definition.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a CreateAlertManagerDefinition operation.
" }, "CreateAlertManagerDefinitionResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"AlertManagerDefinitionStatus", "documentation":"The status of alert manager definition.
" } }, "documentation":"Represents the output of a CreateAlertManagerDefinition operation.
" }, "CreateRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ "data", "name", "workspaceId" ], "members":{ "clientToken":{ "shape":"IdempotencyToken", "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", "idempotencyToken":true }, "data":{ "shape":"RuleGroupsNamespaceData", "documentation":"The namespace data that define the rule groups.
" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace name.
" }, "tags":{ "shape":"TagMap", "documentation":"Optional, user-provided tags for this rule groups namespace.
" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The ID of the workspace in which to create the rule group namespace.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a CreateRuleGroupsNamespace operation.
" }, "CreateRuleGroupsNamespaceResponse":{ "type":"structure", "required":[ "arn", "name", "status" ], "members":{ "arn":{ "shape":"RuleGroupsNamespaceArn", "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace name.
" }, "status":{ "shape":"RuleGroupsNamespaceStatus", "documentation":"The status of rule groups namespace.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags of this rule groups namespace.
" } }, "documentation":"Represents the output of a CreateRuleGroupsNamespace operation.
" }, "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 }, "tags":{ "shape":"TagMap", "documentation":"Optional, user-provided tags for this workspace.
" } }, "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).
" }, "tags":{ "shape":"TagMap", "documentation":"The tags of this workspace.
" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The generated ID of the workspace that was just created.
" } }, "documentation":"Represents the output of a CreateWorkspace operation.
" }, "DeleteAlertManagerDefinitionRequest":{ "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 in which to delete the alert manager definition.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a DeleteAlertManagerDefinition operation.
" }, "DeleteRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ "name", "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" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace name.
", "location":"uri", "locationName":"name" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The ID of the workspace to delete rule group definition.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a DeleteRuleGroupsNamespace 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.
" }, "DescribeAlertManagerDefinitionRequest":{ "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 DescribeAlertManagerDefinition operation.
" }, "DescribeAlertManagerDefinitionResponse":{ "type":"structure", "required":["alertManagerDefinition"], "members":{ "alertManagerDefinition":{ "shape":"AlertManagerDefinitionDescription", "documentation":"The properties of the selected workspace's alert manager definition.
" } }, "documentation":"Represents the output of a DescribeAlertManagerDefinition operation.
" }, "DescribeRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ "name", "workspaceId" ], "members":{ "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace.
", "location":"uri", "locationName":"name" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The ID of the workspace to describe.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a DescribeRuleGroupsNamespace operation.
" }, "DescribeRuleGroupsNamespaceResponse":{ "type":"structure", "required":["ruleGroupsNamespace"], "members":{ "ruleGroupsNamespace":{ "shape":"RuleGroupsNamespaceDescription", "documentation":"The selected rule groups namespace.
" } }, "documentation":"Represents the output of a DescribeRuleGroupsNamespace 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} }, "ListRuleGroupsNamespacesRequest":{ "type":"structure", "required":["workspaceId"], "members":{ "maxResults":{ "shape":"ListRuleGroupsNamespacesRequestMaxResultsInteger", "documentation":"Maximum results to return in response (default=100, maximum=1000).
", "location":"querystring", "locationName":"maxResults" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.
", "location":"querystring", "locationName":"name" }, "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 ListRuleGroupsNamespaces request.
", "location":"querystring", "locationName":"nextToken" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The ID of the workspace.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a ListRuleGroupsNamespaces operation.
" }, "ListRuleGroupsNamespacesRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":1000, "min":1 }, "ListRuleGroupsNamespacesResponse":{ "type":"structure", "required":["ruleGroupsNamespaces"], "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"Pagination token to use when requesting the next page in this list.
" }, "ruleGroupsNamespaces":{ "shape":"RuleGroupsNamespaceSummaryList", "documentation":"The list of the selected rule groups namespaces.
" } }, "documentation":"Represents the output of a ListRuleGroupsNamespaces operation.
" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"String", "documentation":"The ARN of the resource.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{"shape":"TagMap"} } }, "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.
" }, "PutAlertManagerDefinitionRequest":{ "type":"structure", "required":[ "data", "workspaceId" ], "members":{ "clientToken":{ "shape":"IdempotencyToken", "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", "idempotencyToken":true }, "data":{ "shape":"AlertManagerDefinitionData", "documentation":"The alert manager definition data.
" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The ID of the workspace in which to update the alert manager definition.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a PutAlertManagerDefinition operation.
" }, "PutAlertManagerDefinitionResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"AlertManagerDefinitionStatus", "documentation":"The status of alert manager definition.
" } }, "documentation":"Represents the output of a PutAlertManagerDefinition operation.
" }, "PutRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ "data", "name", "workspaceId" ], "members":{ "clientToken":{ "shape":"IdempotencyToken", "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", "idempotencyToken":true }, "data":{ "shape":"RuleGroupsNamespaceData", "documentation":"The namespace data that define the rule groups.
" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace name.
", "location":"uri", "locationName":"name" }, "workspaceId":{ "shape":"WorkspaceId", "documentation":"The ID of the workspace in which to update the rule group namespace.
", "location":"uri", "locationName":"workspaceId" } }, "documentation":"Represents the input of a PutRuleGroupsNamespace operation.
" }, "PutRuleGroupsNamespaceResponse":{ "type":"structure", "required":[ "arn", "name", "status" ], "members":{ "arn":{ "shape":"RuleGroupsNamespaceArn", "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace name.
" }, "status":{ "shape":"RuleGroupsNamespaceStatus", "documentation":"The status of rule groups namespace.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags of this rule groups namespace.
" } }, "documentation":"Represents the output of a PutRuleGroupsNamespace operation.
" }, "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 }, "RuleGroupsNamespaceArn":{ "type":"string", "documentation":"An ARN identifying a rule groups namespace.
" }, "RuleGroupsNamespaceData":{ "type":"blob", "documentation":"The rule groups namespace data.
" }, "RuleGroupsNamespaceDescription":{ "type":"structure", "required":[ "arn", "createdAt", "data", "modifiedAt", "name", "status" ], "members":{ "arn":{ "shape":"RuleGroupsNamespaceArn", "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The time when the rule groups namespace was created.
" }, "data":{ "shape":"RuleGroupsNamespaceData", "documentation":"The rule groups namespace data.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The time when the rule groups namespace was modified.
" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace name.
" }, "status":{ "shape":"RuleGroupsNamespaceStatus", "documentation":"The status of rule groups namespace.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags of this rule groups namespace.
" } }, "documentation":"Represents a description of the rule groups namespace.
" }, "RuleGroupsNamespaceName":{ "type":"string", "documentation":"The namespace name that the rule group belong to.
", "max":64, "min":1, "pattern":"[0-9A-Za-z][-.0-9A-Z_a-z]*" }, "RuleGroupsNamespaceStatus":{ "type":"structure", "required":["statusCode"], "members":{ "statusCode":{ "shape":"RuleGroupsNamespaceStatusCode", "documentation":"Status code of this namespace.
" }, "statusReason":{ "shape":"String", "documentation":"The reason for failure if any.
" } }, "documentation":"Represents the status of a namespace.
" }, "RuleGroupsNamespaceStatusCode":{ "type":"string", "documentation":"State of a namespace.
", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" ] }, "RuleGroupsNamespaceSummary":{ "type":"structure", "required":[ "arn", "createdAt", "modifiedAt", "name", "status" ], "members":{ "arn":{ "shape":"RuleGroupsNamespaceArn", "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" }, "createdAt":{ "shape":"Timestamp", "documentation":"The time when the rule groups namespace was created.
" }, "modifiedAt":{ "shape":"Timestamp", "documentation":"The time when the rule groups namespace was modified.
" }, "name":{ "shape":"RuleGroupsNamespaceName", "documentation":"The rule groups namespace name.
" }, "status":{ "shape":"RuleGroupsNamespaceStatus", "documentation":"The status of rule groups namespace.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags of this rule groups namespace.
" } }, "documentation":"Represents a summary of the rule groups namespace.
" }, "RuleGroupsNamespaceSummaryList":{ "type":"list", "member":{"shape":"RuleGroupsNamespaceSummary"}, "documentation":"A list of rule groups namespace summary.
" }, "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"}, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagMap":{ "type":"map", "key":{ "shape":"TagKey", "documentation":"The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:
.
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @
" }, "documentation":"The list of tags assigned to the resource.
", "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"The ARN of the resource.
", "location":"uri", "locationName":"resourceArn" }, "tags":{"shape":"TagMap"} } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "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"}, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"String", "documentation":"The ARN of the resource.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeys", "documentation":"One or more tag keys
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "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.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags 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.
" }, "tags":{ "shape":"TagMap", "documentation":"The tags 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
" }