openapi: 3.2.0
info:
version: '2017-03-31'
x-release: v4
title: 'AWS Glue #X Amz Target=AWSGlue.PutResourcePolicy API'
description: 'Glue
Defines the public endpoint for the Glue service.'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
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: glue
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/glue-2017-03-31.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
servers:
- url: http://glue.{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 Glue multi-region endpoint
- url: https://glue.{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 Glue multi-region endpoint
- url: http://glue.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
- url: https://glue.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Glue endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: 'AWS Glue #X Amz Target=AWSGlue.PutResourcePolicy API'
paths:
/#X-Amz-Target=AWSGlue.PutResourcePolicy:
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'
post:
operationId: PutResourcePolicy
description: Sets the Data Catalog resource policy for access control.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyResponse'
examples:
PutResourcePolicy200Example:
summary: Default PutResourcePolicy 200 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'480':
description: EntityNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/EntityNotFoundException'
examples:
PutResourcePolicy480Example:
summary: Default PutResourcePolicy 480 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'481':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
PutResourcePolicy481Example:
summary: Default PutResourcePolicy 481 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'482':
description: OperationTimeoutException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationTimeoutException'
examples:
PutResourcePolicy482Example:
summary: Default PutResourcePolicy 482 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'483':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
PutResourcePolicy483Example:
summary: Default PutResourcePolicy 483 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
'484':
description: ConditionCheckFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionCheckFailureException'
examples:
PutResourcePolicy484Example:
summary: Default PutResourcePolicy 484 response
x-microcks-default: true
value:
JobRunId: jr_abc123
State: SUCCEEDED
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSGlue.PutResourcePolicy
summary: Amazon Glue Put Resource Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- 'AWS Glue #X Amz Target=AWSGlue.PutResourcePolicy API'
components:
schemas:
InvalidInputException: {}
GlueResourceArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn):glue:.*
minLength: 1
maxLength: 10240
PolicyJsonString:
type: string
minLength: 2
EntityNotFoundException: {}
InternalServiceException: {}
EnableHybridValues:
type: string
enum:
- 'TRUE'
- 'FALSE'
ExistCondition:
type: string
enum:
- MUST_EXIST
- NOT_EXIST
- NONE
ConditionCheckFailureException: {}
PutResourcePolicyResponse:
type: object
properties:
PolicyHash:
allOf:
- $ref: '#/components/schemas/HashString'
- description: A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.
PutResourcePolicyRequest:
type: object
required:
- PolicyInJson
title: PutResourcePolicyRequest
properties:
PolicyInJson:
allOf:
- $ref: '#/components/schemas/PolicyJsonString'
- description: Contains the policy document to set, in JSON format.
ResourceArn:
allOf:
- $ref: '#/components/schemas/GlueResourceArn'
- description: Do not use. For internal use only.
PolicyHashCondition:
allOf:
- $ref: '#/components/schemas/HashString'
- description: The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.
PolicyExistsCondition:
allOf:
- $ref: '#/components/schemas/ExistCondition'
- description: A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call does not depend on the existence of a policy.
EnableHybrid:
allOf:
- $ref: '#/components/schemas/EnableHybridValues'
- description:
If 'TRUE', indicates that you are using both methods to grant cross-account access to Data Catalog resources:
By directly updating the resource policy with PutResourePolicy
By using the Grant permissions command on the Amazon Web Services Management Console.
Must be set to 'TRUE' if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'.