openapi-directory/api/amazonaws.com/xray.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2016-04-12","x-release":"v4","title":"AWS X-Ray","description":"Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"xray","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/xray-2016-04-12.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/xray/"},"servers":[{"url":"http://xray.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS X-Ray multi-region endpoint"},{"url":"https://xray.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS X-Ray multi-region endpoint"},{"url":"http://xray.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS X-Ray endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://xray.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS X-Ray endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/Traces":{"post":{"operationId":"BatchGetTraces","description":"Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use <code>GetTraceSummaries</code> to get a list of trace IDs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGetTracesResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TraceIds"],"properties":{"TraceIds":{"description":"Specify the trace IDs of requests for which to retrieve segments.","type":"array","items":{"$ref":"#/components/schemas/TraceId"}},"NextToken":{"description":"Pagination token.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/CreateGroup":{"post":{"operationId":"CreateGroup","description":"Creates a group resource with a name and a filter expression. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupName"],"properties":{"GroupName":{"description":"The case-sensitive name of the new group. Default is a reserved name and names must be unique.","type":"string","minLength":1,"maxLength":32},"FilterExpression":{"description":"The filter expression defining criteria by which to group traces.","type":"string"},"InsightsConfiguration":{"description":"The structure containing configurations related to insights.","type":"object","properties":{"InsightsEnabled":{"allOf":[{"$ref":"#/components/schemas/NullableBoolean"},{"description":"Set the InsightsEnabled value to true to enable insights or false to disable insights."}]},"NotificationsEnabled":{"allOf":[{"$ref":"#/components/schemas/NullableBoolean"},{"description":"Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true."}]}}},"Tags":{"description":"<p>A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p> </li> </ul>","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":0,"maxItems":200}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/CreateSamplingRule":{"post":{"operationId":"CreateSamplingRule","description":"Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with <a href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html\">GetSamplingRules</a>, and evaluate each rule in ascending order of <i>priority</i> for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with <a href=\"https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html\">GetSamplingTargets</a> to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSamplingRuleResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}},"482":{"description":"RuleLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleLimitExceededException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SamplingRule"],"properties":{"SamplingRule":{"description":"A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.","type":"object","properties":{"RuleName":{"allOf":[{"$ref":"#/components/schemas/RuleName"},{"description":"The name of the sampling rule. Specify a rule by either name or ARN, but not both."}]},"RuleARN":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The ARN of the sampling rule. Specify a rule by either name or ARN, but not both."}]},"ResourceARN":{"allOf":[{"$ref":"#/components/schemas/ResourceARN"},{"description":"Matches the ARN of the Amazon Web Services resource on which the service runs."}]},"Priority":{"allOf":[{"$ref":"#/components/schemas/Priority"},{"description":"The priority of the sampling rule."}]},"FixedRate":{"allOf":[{"$ref":"#/components/schemas/FixedRate"},{"description":"The percentage of matching requests to instrument, after the reservoir is exhausted."}]},"ReservoirSize":{"allOf":[{"$ref":"#/components/schemas/ReservoirSize"},{"description":"A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively."}]},"ServiceName":{"allOf":[{"$ref":"#/components/schemas/ServiceName"},{"description":"Matches the <code>name</code> that the service uses to identify itself in segments."}]},"ServiceType":{"allOf":[{"$ref":"#/components/schemas/ServiceType"},{"description":"Matches the <code>origin</code> that the service uses to identify its type in segments."}]},"Host":{"allOf":[{"$ref":"#/components/schemas/Host"},{"description":"Matches the hostname from a request URL."}]},"HTTPMethod":{"allOf":[{"$ref":"#/components/schemas/HTTPMethod"},{"description":"Matches the HTTP method of a request."}]},"URLPath":{"allOf":[{"$ref":"#/components/schemas/URLPath"},{"description":"Matches the path from a request URL."}]},"Version":{"allOf":[{"$ref":"#/components/schemas/Version"},{"description":"The version of the sampling rule format (<code>1</code>)."}]},"Attributes":{"allOf":[{"$ref":"#/components/schemas/AttributeMap"},{"description":"Matches attributes derived from the request."}]}}},"Tags":{"description":"<p>A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p> </li> </ul>","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":0,"maxItems":200}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/DeleteGroup":{"post":{"operationId":"DeleteGroup","description":"Deletes a group resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"GroupName":{"description":"The case-sensitive name of the group.","type":"string","minLength":1,"maxLength":32},"GroupARN":{"description":"The ARN of the group that was generated on creation.","type":"string","minLength":1,"maxLength":400}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/DeleteResourcePolicy":{"post":{"operationId":"DeleteResourcePolicy","description":"Deletes a resource policy from the target Amazon Web Services account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResourcePolicyResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"InvalidPolicyRevisionIdException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPolicyRevisionIdException"}}}},"482":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PolicyName"],"properties":{"PolicyName":{"description":"The name of the resource policy to delete.","type":"string","pattern":"[\\w+=,.@-]+","minLength":1,"maxLength":128},"PolicyRevisionId":{"description":"Specifies a specific policy revision to delete. Provide a <code>PolicyRevisionId</code> to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an <code>InvalidPolicyRevisionIdException</code> exception is returned. ","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/DeleteSamplingRule":{"post":{"operationId":"DeleteSamplingRule","description":"Deletes a sampling rule.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSamplingRuleResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"RuleName":{"description":"The name of the sampling rule. Specify a rule by either name or ARN, but not both.","type":"string"},"RuleARN":{"description":"The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/EncryptionConfig":{"post":{"operationId":"GetEncryptionConfig","description":"Retrieves the current encryption configuration for X-Ray data.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEncryptionConfigResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/GetGroup":{"post":{"operationId":"GetGroup","description":"Retrieves group resource details.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"GroupName":{"description":"The case-sensitive name of the group.","type":"string","minLength":1,"maxLength":32},"GroupARN":{"description":"The ARN of the group that was generated on creation.","type":"string","minLength":1,"maxLength":400}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/Groups":{"post":{"operationId":"GetGroups","description":"Retrieves all active group details.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupsResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"NextToken":{"description":"Pagination token.","type":"string","minLength":1,"maxLength":100}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/Insight":{"post":{"operationId":"GetInsight","description":"Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInsightResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InsightId"],"properties":{"InsightId":{"description":"The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.","type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/InsightEvents":{"post":{"operationId":"GetInsightEvents","description":"X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInsightEventsResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InsightId"],"properties":{"InsightId":{"description":"The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.","type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}"},"MaxResults":{"description":"Used to retrieve at most the specified value of events.","type":"integer","minimum":1,"maximum":50},"NextToken":{"description":"Specify the pagination token returned by a previous request to retrieve the next page of events. ","type":"string","minLength":1,"maxLength":2000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/InsightImpactGraph":{"post":{"operationId":"GetInsightImpactGraph","description":"Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInsightImpactGraphResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InsightId","StartTime","EndTime"],"properties":{"InsightId":{"description":"The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.","type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}"},"StartTime":{"description":"The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.","type":"string","format":"date-time"},"EndTime":{"description":"The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours. ","type":"string","format":"date-time"},"NextToken":{"description":"Specify the pagination token returned by a previous request to retrieve the next page of results. ","type":"string","minLength":1,"maxLength":2000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/InsightSummaries":{"post":{"operationId":"GetInsightSummaries","description":"Retrieves the summaries of all insights in the specified group matching the provided filter values.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInsightSummariesResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartTime","EndTime"],"properties":{"States":{"description":"The list of insight states. ","type":"array","items":{"$ref":"#/components/schemas/InsightState"},"minItems":0,"maxItems":1},"GroupARN":{"description":"The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.","type":"string","minLength":1,"maxLength":400},"GroupName":{"description":"The name of the group. Required if the GroupARN isn't provided.","type":"string","minLength":1,"maxLength":32},"StartTime":{"description":"The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.","type":"string","format":"date-time"},"EndTime":{"description":"The end of the time frame in which the insights ended. The end time can't be more than 30 days old.","type":"string","format":"date-time"},"MaxResults":{"description":"The maximum number of results to display.","type":"integer","minimum":1,"maximum":100},"NextToken":{"description":"Pagination token.","type":"string","minLength":1,"maxLength":2000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/GetSamplingRules":{"post":{"operationId":"GetSamplingRules","description":"Retrieves all sampling rules.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSamplingRulesResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"NextToken":{"description":"Pagination token.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/SamplingStatisticSummaries":{"post":{"operationId":"GetSamplingStatisticSummaries","description":"Retrieves information about recent sampling results for all sampling rules.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSamplingStatisticSummariesResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"NextToken":{"description":"Pagination token.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/SamplingTargets":{"post":{"operationId":"GetSamplingTargets","description":"Requests a sampling quota for rules that the service is using to sample requests. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSamplingTargetsResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SamplingStatisticsDocuments"],"properties":{"SamplingStatisticsDocuments":{"description":"Information about rules that the service is using to sample requests.","type":"array","items":{"$ref":"#/components/schemas/SamplingStatisticsDocument"},"maxItems":25}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ServiceGraph":{"post":{"operationId":"GetServiceGraph","description":"Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the <a href=\"https://docs.aws.amazon.com/xray/index.html\">Amazon Web Services X-Ray SDK</a>. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceGraphResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartTime","EndTime"],"properties":{"StartTime":{"description":"The start of the time frame for which to generate a graph.","type":"string","format":"date-time"},"EndTime":{"description":"The end of the timeframe for which to generate a graph.","type":"string","format":"date-time"},"GroupName":{"description":"The name of a group based on which you want to generate a graph.","type":"string","minLength":1,"maxLength":32},"GroupARN":{"description":"The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.","type":"string","minLength":1,"maxLength":400},"NextToken":{"description":"Pagination token.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/TimeSeriesServiceStatistics":{"post":{"operationId":"GetTimeSeriesServiceStatistics","description":"Get an aggregation of service statistics defined by a specific time range.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTimeSeriesServiceStatisticsResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartTime","EndTime"],"properties":{"StartTime":{"description":"The start of the time frame for which to aggregate statistics.","type":"string","format":"date-time"},"EndTime":{"description":"The end of the time frame for which to aggregate statistics.","type":"string","format":"date-time"},"GroupName":{"description":"The case-sensitive name of the group for which to pull statistics from.","type":"string","minLength":1,"maxLength":32},"GroupARN":{"description":"The Amazon Resource Name (ARN) of the group for which to pull statistics from.","type":"string","minLength":1,"maxLength":400},"EntitySelectorExpression":{"description":"A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned. ","type":"string","minLength":1,"maxLength":500},"Period":{"description":"Aggregation period in seconds.","type":"integer"},"ForecastStatistics":{"description":"The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.","type":"boolean"},"NextToken":{"description":"Pagination token.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/TraceGraph":{"post":{"operationId":"GetTraceGraph","description":"Retrieves a service graph for one or more specific trace IDs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTraceGraphResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TraceIds"],"properties":{"TraceIds":{"description":"Trace IDs of requests for which to generate a service graph.","type":"array","items":{"$ref":"#/components/schemas/TraceId"}},"NextToken":{"description":"Pagination token.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/TraceSummaries":{"post":{"operationId":"GetTraceSummaries","description":"<p>Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to <code>BatchGetTraces</code>.</p> <p>A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through <code>api.example.com</code>:</p> <p> <code>service(\"api.example.com\")</code> </p> <p>This filter expression finds traces that have an annotation named <code>account</code> with the value <code>12345</code>:</p> <p> <code>annotation.account = \"12345\"</code> </p> <p>For a full list of indexed fields and keywords that you can use in filter expressions, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html\">Using Filter Expressions</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTraceSummariesResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartTime","EndTime"],"properties":{"StartTime":{"description":"The start of the time frame for which to retrieve traces.","type":"string","format":"date-time"},"EndTime":{"description":"The end of the time frame for which to retrieve traces.","type":"string","format":"date-time"},"TimeRangeType":{"description":"A parameter to indicate whether to query trace summaries by TraceId or Event time.","type":"string","enum":["TraceId","Event"]},"Sampling":{"description":"Set to <code>true</code> to get summaries for only a subset of available traces.","type":"boolean"},"SamplingStrategy":{"description":"The name and value of a sampling rule to apply to a trace summary.","type":"object","properties":{"Name":{"allOf":[{"$ref":"#/components/schemas/SamplingStrategyName"},{"description":"The name of a sampling rule."}]},"Value":{"allOf":[{"$ref":"#/components/schemas/NullableDouble"},{"description":"The value of a sampling rule."}]}}},"FilterExpression":{"description":"Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.","type":"string"},"NextToken":{"description":"Specify the pagination token returned by a previous request to retrieve the next page of results.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ListResourcePolicies":{"post":{"operationId":"ListResourcePolicies","description":"Returns the list of resource policies in the target Amazon Web Services account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResourcePoliciesResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"NextToken":{"description":"Not currently supported.","type":"string","minLength":1,"maxLength":100}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ListTagsForResource":{"post":{"operationId":"ListTagsForResource","description":"Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceARN"],"properties":{"ResourceARN":{"description":"The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.","type":"string","minLength":1,"maxLength":1011},"NextToken":{"description":"A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with the current page of results as the value of this parameter to get the next page of results.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/PutEncryptionConfig":{"post":{"operationId":"PutEncryptionConfig","description":"Updates the encryption configuration for X-Ray data.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutEncryptionConfigResult"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Type"],"properties":{"KeyId":{"description":"<p>An Amazon Web Services KMS key in one of the following formats:</p> <ul> <li> <p> <b>Alias</b> - The name of the key. For example, <code>alias/MyKey</code>.</p> </li> <li> <p> <b>Key ID</b> - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Amazon Web Services X-Ray does not support asymmetric KMS keys.</p> </li> <li> <p> <b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account.</p> </li> </ul> <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>","type":"string","minLength":1,"maxLength":3000},"Type":{"description":"The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set to <code>NONE</code> for default encryption.","type":"string","enum":["NONE","KMS"]}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/PutResourcePolicy":{"post":{"operationId":"PutResourcePolicy","description":" Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutResourcePolicyResult"}}}},"480":{"description":"MalformedPolicyDocumentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MalformedPolicyDocumentException"}}}},"481":{"description":"LockoutPreventionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockoutPreventionException"}}}},"482":{"description":"InvalidPolicyRevisionIdException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPolicyRevisionIdException"}}}},"483":{"description":"PolicySizeLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicySizeLimitExceededException"}}}},"484":{"description":"PolicyCountLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCountLimitExceededException"}}}},"485":{"description":"ThrottledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottledException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PolicyName","PolicyDocument"],"properties":{"PolicyName":{"description":"The name of the resource policy. Must be unique within a specific Amazon Web Services account.","type":"string","pattern":"[\\w+=,.@-]+","minLength":1,"maxLength":128},"PolicyDocument":{"description":"The resource policy document, which can be up to 5kb in size.","type":"string"},"PolicyRevisionId":{"description":"<p>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.</p> <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a <code>PolicyRevisionId</code> of 0. In this case, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception if a resource policy with the same name already exists. </p>","type":"string"},"BypassPolicyLockoutCheck":{"description":"<p>A flag to indicate whether to bypass the resource policy lockout safety check.</p> <important> <p>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</p> </important> <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <code>PutResourcePolicy</code> request.</p> <p>The default value is false.</p>","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/