Acciones, recursos y claves de condición para la administración de Amazon API Gateway
Amazon API Gateway Management (prefijo de servicio:apigateway) proporciona las siguientes operaciones, recursos, acciones y claves de condición específicos del servicio para su uso en las políticas de permisos de IAM.
Referencias:
-
Obtenga información para configurar este servicio.
-
Vea una lista de las operaciones de API disponibles para este servicio.
-
Obtenga información sobre cómo proteger este servicio y sus recursos mediante las políticas de permisos de IAM.
-
Consulte la referencia de autorización de servicio programática de este servicio
.
Temas
Operaciones de API definidas por Amazon API Gateway Management
En la siguiente tabla, se asignan las operaciones de la API a las acciones de IAM que autorizan. Solo se muestran las claves de condición que tienen valores estáticos para la API y la acción determinadas; para ver el conjunto completo de claves de condición que admite cada acción, consulte la tabla de acciones.
| Operación | Acción de IAM | Clave de condición | Valores posibles | Nivel de acceso |
|---|---|---|---|---|
|
CreateApiKey |
Escritura |
|||
Escritura |
||||
|
CreateAuthorizer |
Escritura |
|||
objetivo: PassedToService |
apigateway.amazonaws.com |
Escritura |
||
|
CreateBasePathMapping |
Escritura |
|||
|
CreateDeployment |
Escritura |
|||
|
CreateDocumentationPart |
Escritura |
|||
|
CreateDocumentationVersion |
Escritura |
|||
|
CreateDomainName |
Gestión de permisos, Write |
|||
Escritura |
||||
Escritura |
||||
Gestión de permisos, Write |
||||
|
CreateDomainNameAccessAssociation |
Gestión de permisos, Write |
|||
Escritura |
||||
Escritura |
||||
|
CreateModel |
Escritura |
|||
|
CreateRequestValidator |
Escritura |
|||
|
CreateResource |
Escritura |
|||
|
CreateRestApi |
Escritura |
|||
Escritura |
||||
Gestión de permisos, Write |
||||
|
CreateStage |
Escritura |
|||
Escritura |
||||
|
CreateUsagePlan |
Escritura |
|||
Escritura |
||||
|
CreateUsagePlanKey |
Escritura |
|||
|
CreateVpcLink |
Escritura |
|||
Escritura |
||||
|
DeleteApiKey |
Escritura |
|||
|
DeleteAuthorizer |
Escritura |
|||
|
DeleteBasePathMapping |
Escritura |
|||
|
DeleteClientCertificate |
Escritura |
|||
|
DeleteDeployment |
Escritura |
|||
|
DeleteDocumentationPart |
Escritura |
|||
|
DeleteDocumentationVersion |
Escritura |
|||
|
DeleteDomainName |
Escritura |
|||
Gestión de permisos, Write |
||||
|
DeleteDomainNameAccessAssociation |
Escritura |
|||
|
DeleteGatewayResponse |
Escritura |
|||
|
DeleteIntegration |
Escritura |
|||
|
DeleteIntegrationResponse |
Escritura |
|||
|
DeleteMethod |
Escritura |
|||
|
DeleteMethodResponse |
Escritura |
|||
|
DeleteModel |
Escritura |
|||
|
DeleteRequestValidator |
Escritura |
|||
|
DeleteResource |
Escritura |
|||
|
DeleteRestApi |
Escritura |
|||
|
DeleteStage |
Escritura |
|||
|
DeleteUsagePlan |
Escritura |
|||
|
DeleteUsagePlanKey |
Escritura |
|||
|
DeleteVpcLink |
Escritura |
|||
|
FlushStageAuthorizersCache |
Escritura |
|||
|
FlushStageCache |
Escritura |
|||
|
GenerateClientCertificate |
Escritura |
|||
Escritura |
||||
|
GetAccount |
Lectura |
|||
|
GetApiKey |
Lectura |
|||
|
GetApiKeys |
Lectura |
|||
|
GetAuthorizer |
Lectura |
|||
|
GetAuthorizers |
Lectura |
|||
|
GetBasePathMapping |
Lectura |
|||
|
GetBasePathMappings |
Lectura |
|||
|
GetClientCertificate |
Lectura |
|||
|
GetClientCertificates |
Lectura |
|||
|
GetDeployment |
Lectura |
|||
|
GetDeployments |
Lectura |
|||
|
GetDocumentationPart |
Lectura |
|||
|
GetDocumentationParts |
Lectura |
|||
|
GetDocumentationVersion |
Lectura |
|||
|
GetDocumentationVersions |
Lectura |
|||
|
GetDomainName |
Lectura |
|||
|
GetDomainNameAccessAssociations |
Lectura |
|||
|
GetDomainNames |
Lectura |
|||
|
GetExport |
Lectura |
|||
|
GetGatewayResponse |
Lectura |
|||
|
GetGatewayResponses |
Lectura |
|||
|
GetIntegration |
Lectura |
|||
|
GetIntegrationResponse |
Lectura |
|||
|
GetMethod |
Lectura |
|||
|
GetMethodResponse |
Lectura |
|||
|
GetModel |
Lectura |
|||
|
GetModelTemplate |
Lectura |
|||
|
GetModels |
Lectura |
|||
|
GetRequestValidator |
Lectura |
|||
|
GetRequestValidators |
Lectura |
|||
|
GetResource |
Lectura |
|||
|
GetResources |
Lectura |
|||
|
GetRestApi |
Lectura |
|||
|
GetRestApis |
Lectura |
|||
|
GetSdk |
Lectura |
|||
|
GetSdkType |
Lectura |
|||
|
GetSdkTypes |
Lectura |
|||
|
GetStage |
Lectura |
|||
|
GetStages |
Lectura |
|||
|
GetTags |
Lectura |
|||
|
GetUsage |
Lectura |
|||
|
GetUsagePlan |
Lectura |
|||
|
GetUsagePlanKey |
Lectura |
|||
|
GetUsagePlanKeys |
Lectura |
|||
|
GetUsagePlans |
Lectura |
|||
|
GetVpcLink |
Lectura |
|||
|
GetVpcLinks |
Lectura |
|||
|
ImportApiKeys |
Escritura |
|||
|
ImportDocumentationParts |
Escritura |
|||
|
ImportRestApi |
Escritura |
|||
Gestión de permisos, Write |
||||
objetivo: PassedToService |
apigateway.amazonaws.com |
Escritura |
||
|
PutGatewayResponse |
Escritura |
|||
|
PutIntegration |
Escritura |
|||
objetivo: PassedToService |
apigateway.amazonaws.com |
Escritura |
||
|
PutIntegrationResponse |
Escritura |
|||
|
PutMethod |
Escritura |
|||
|
PutMethodResponse |
Escritura |
|||
|
PutRestApi |
Escritura |
|||
Gestión de permisos, Write |
||||
objetivo: PassedToService |
apigateway.amazonaws.com |
Escritura |
||
|
RejectDomainNameAccessAssociation |
Gestión de permisos, Write |
|||
|
TagResource |
Escritura |
|||
Escritura |
||||
Escritura |
||||
|
TestInvokeAuthorizer |
Escritura |
|||
|
TestInvokeMethod |
Escritura |
|||
|
UntagResource |
Escritura |
|||
Escritura |
||||
|
UpdateAccount |
Escritura |
|||
objetivo: PassedToService |
apigateway.amazonaws.com |
Escritura |
||
|
UpdateApiKey |
Escritura |
|||
|
UpdateAuthorizer |
Escritura |
|||
objetivo: PassedToService |
apigateway.amazonaws.com |
Escritura |
||
|
UpdateBasePathMapping |
Escritura |
|||
|
UpdateClientCertificate |
Escritura |
|||
|
UpdateDeployment |
Escritura |
|||
|
UpdateDocumentationPart |
Escritura |
|||
|
UpdateDocumentationVersion |
Escritura |
|||
|
UpdateDomainName |
Gestión de permisos, Write |
|||
Escritura |
||||
Gestión de permisos, Write |
||||
Gestión de permisos, Write |
||||
Gestión de permisos, Write |
||||
|
UpdateGatewayResponse |
Escritura |
|||
|
UpdateIntegration |
Escritura |
|||
objetivo: PassedToService |
apigateway.amazonaws.com |
Escritura |
||
|
UpdateIntegrationResponse |
Escritura |
|||
|
UpdateMethod |
Escritura |
|||
|
UpdateMethodResponse |
Escritura |
|||
|
UpdateModel |
Escritura |
|||
|
UpdateRequestValidator |
Escritura |
|||
|
UpdateResource |
Escritura |
|||
|
UpdateRestApi |
Escritura |
|||
Gestión de permisos, Write |
||||
|
UpdateStage |
Escritura |
|||
|
UpdateUsage |
Escritura |
|||
|
UpdateUsagePlan |
Escritura |
|||
|
UpdateVpcLink |
Escritura |
Acciones definidas por la administración de Amazon API Gateway
Puede especificar las siguientes acciones en el elemento Action de una declaración de política de IAM. Utilice políticas para conceder permisos para realizar una operación en AWS. Cuando utiliza una acción en una política, normalmente permite o deniega el acceso a la operación de la API o comandos de la CLI con el mismo nombre. No obstante, en algunos casos, una sola acción controla el acceso a más de una operación. Asimismo, algunas operaciones requieren varias acciones diferentes.
Tipos de recursos definidos por la administración de Amazon API Gateway
Los siguientes tipos de recurso están definidos por este servicio y se pueden utilizar en el elemento Resource de las instrucciones de política de permisos de IAM.
| Tipos de recurso | ARN | Claves de condición |
|---|---|---|
arn: $ {Partition}: apigateway: $ {Region}:: /account |
||
arn: $ {Partition} :apigateway: $ {Region}:: /apikeys/$ {} ApiKeyId |
||
arn: $ {Partition}: apigateway: $ {Region}: /apikeys |
||
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /authorizers/$ {}, arn: $ {PartitionApiId} :apigateway: $ {RegionAuthorizerId}:: /restapis/$ {} /authorizers/$ {} RestApiId AuthorizerId |
puerta de enlace api: Request/AuthorizerType |
|
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /authorizers, arn: $ {Partition} :apigateway: $ {RegionApiId}:: /restapis/$ {} /authorizers RestApiId |
||
arn: $ {Partition} :apigateway: $ {Region}: /domainnames/$ {} /basepathmappings/$ {} DomainName BasePath |
||
arn: $ {Partition} :apigateway: $ {Region}: /domainnames/$ {} /basepathmappings DomainName |
||
arn: $ {Partition} :apigateway: $ {Region}: /clientcertificates/$ {} ClientCertificateId |
||
arn: $ {Partition}: apigateway: $ {Region}: /clientcertificates |
||
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /deployments/$ {}, arn: $ {PartitionApiId} :apigateway: $ {RegionDeploymentId}:: /restapis/$ {} /deployments/$ {} RestApiId DeploymentId |
||
arn: $ {Partition} :apigateway: $ {Region}:: /apis/$ {} /deployments, arn: $ {Partition} :apigateway: $ {RegionApiId}:: /restapis/$ {} /deployments RestApiId |
||
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {}//$ {} RestApiId documentation/parts DocumentationPartId |
||
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {}/RestApiIddocumentation/parts |
||
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {}//$ {} RestApiId documentation/versions DocumentationVersionId |
||
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {}/RestApiIddocumentation/versions |
||
arn: $ {Partition} :apigateway: $ {Region}: /domainnames/$ {} DomainName |
puerta de enlace api: Request/EndpointType puerta de enlace api: Request/MtlsTrustStoreUri puerta de enlace api: Request/MtlsTrustStoreVersion puerta de enlace api: Request/SecurityPolicy puerta de enlace api: Resource/EndpointType puerta de enlace api: Resource/MtlsTrustStoreUri puerta de enlace api: Resource/MtlsTrustStoreVersion puerta de enlace api: Resource/RoutingMode |
|
arn: $ {Partition} :apigateway: $ {Region} :$ {Account} :/ domainnameaccessassociations/domainname /$ {} /$ {} DomainName SourceType SourceId |
||
arn: $ {Partition}: apigateway: $ {Region} :$ {Account} :/domainnameaccessassociations |
puerta de enlace api: Request/AccessAssociationSource |
|
arn: $ {Partition} :apigateway: $ {Region}: /domainnames |
puerta de enlace api: Request/EndpointType puerta de enlace api: Request/MtlsTrustStoreUri puerta de enlace api: Request/MtlsTrustStoreVersion puerta de enlace api: Request/SecurityPolicy |
|
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {} /gatewayresponses/$ {} RestApiId ResponseType |
||
arn: $ {Partition}: apigateway: $ {Region}: /restapis/$ {} /gatewayresponses RestApiId |
||
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /integrations/$ {}, arn: $ {PartitionApiId} :apigateway: $ {RegionIntegrationId}:: /restapis/$ {} /resources/$ {} /methods/$ {} /integration RestApiId ResourceId HttpMethodType |
||
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /integrations/$ {} /integrationresponses/$ {ApiId}, arn: $ {Partition} :apigateway: $ {RegionIntegrationId}:: /restapis/$ {IntegrationResponseId} /resources/$ {} /methods/$ {}//{ $} RestApiId ResourceId HttpMethodType integration/responses StatusCode |
||
arn: $ {Partition} :apigateway: $ {Region}:: /restapis/$ {} /resources/$ {} /methods/$ {} RestApiId ResourceId HttpMethodType |
puerta de enlace api: Request/ApiKeyRequired puerta de enlace api: Request/RouteAuthorizationType puerta de enlace api: Resource/ApiKeyRequired |
|
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {} /resources/$ {} /methods/$ {} /responses/$ {} RestApiId ResourceId HttpMethodType StatusCode |
||
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /models/$ {}, arn: $ {PartitionApiId} :apigateway: $ {RegionModelId}:: /restapis/$ {} /models/$ {} RestApiId ModelName |
||
arn: $ {Partition}: apigateway: $ {Region}: /apis/$ {} /models, arn: $ {PartitionApiId} :apigateway: $ {Region}:: /restapis/$ {} /models RestApiId |
||
arn: $ {Partition} :apigateway: $ {Region}: /domainnames/$ {} +$ {} /basepathmappings/$ {} DomainName DomainIdentifier BasePath |
||
arn: $ {Partition} :apigateway: $ {Region}: /domainnames/$ {} +$ {} /basepathmappings DomainName DomainIdentifier |
||
arn: $ {Partition} :apigateway: $ {Region} :$ {Account} :/domainnames/$ {} +$ {} DomainName DomainIdentifier |
puerta de enlace api: Request/EndpointType puerta de enlace api: Resource/EndpointType |
|
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {} /requestvalidators/$ {} RestApiId RequestValidatorId |
||
arn: $ {Partition}: apigateway: $ {Region}: /restapis/$ {} /requestvalidators RestApiId |
||
arn: $ {Partition} :apigateway: $ {Region}:: /restapis/$ {} /resources/$ {} RestApiId ResourceId |
||
arn: $ {Partition}: apigateway: $ {Region}: /restapis/$ {} /resources RestApiId |
||
arn: $ {Partition} :apigateway: $ {Region}: /restapis/$ {} RestApiId |
puerta de enlace api: Request/ApiKeyRequired puerta de enlace api: Request/ApiName puerta de enlace api: Request/AuthorizerType puerta de enlace api: Request/DisableExecuteApiEndpoint puerta de enlace api: Request/EndpointType puerta de enlace api: Request/RouteAuthorizationType puerta de enlace api: Request/SecurityPolicy puerta de enlace api: Resource/ApiKeyRequired puerta de enlace api: Resource/ApiName puerta de enlace api: Resource/AuthorizerType puerta de enlace api: Resource/DisableExecuteApiEndpoint puerta de enlace api: Resource/EndpointType puerta de enlace api: Resource/RouteAuthorizationType |
|
arn: $ {Partition} :apigateway: $ {Region}: /restapis |
puerta de enlace api: Request/ApiKeyRequired puerta de enlace api: Request/ApiName puerta de enlace api: Request/AuthorizerType puerta de enlace api: Request/DisableExecuteApiEndpoint puerta de enlace api: Request/EndpointType puerta de enlace api: Request/RouteAuthorizationType |
|
arn: $ {Partition}: apigateway: $ {Region}:: /restapis/$ {} /stages/$ {} /sdks/$ {} RestApiId StageName SdkType |
||
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /stages/$ {}, arn: $ {PartitionApiId} :apigateway: $ {RegionStageName}:: /restapis/$ {} /stages/$ {} RestApiId StageName |
puerta de enlace api: Request/AccessLoggingDestination puerta de enlace api: Request/AccessLoggingFormat puerta de enlace api: Resource/AccessLoggingDestination |
|
arn: $ {Partition} :apigateway: $ {Region}: /apis/$ {} /stages, arn: $ {PartitionApiId} :apigateway: $ {Region}:: /restapis/$ {} /stages RestApiId |
puerta de enlace api: Request/AccessLoggingDestination |
|
arn: $ {Partition}: apigateway: $ {Region}:: /tags/$ {} UrlEncodedResourceARN |
||
arn: $ {Partition}: apigateway: $ {Region}://$ {} /template restapis/models ModelName |
||
arn: $ {Partition} :apigateway: $ {Region}: /usageplans/$ {} UsagePlanId |
||
arn: $ {Partition} :apigateway: $ {Region}: /usageplans/$ {} /keys/$ {Id} UsagePlanId |
||
arn: $ {Partition} :apigateway: $ {Region}: /usageplans/$ {} /keys UsagePlanId |
||
arn: $ {Partition}: apigateway: $ {Region}: /usageplans |
||
arn: $ {Partition} :apigateway: $ {Region}: /vpclinks/$ {} VpcLinkId |
||
arn: $ {Partition} :apigateway: $ {Region}: /vpclinks |
Claves de condición para la administración de Amazon API Gateway
La administración de Amazon API Gateway define las siguientes claves de condición que pueden usarse en el elemento Condition de una política de IAM.
| Claves de condición | Descripción | Tipo |
|---|---|---|
Filtra el acceso por fuente de asociación de acceso. Disponible durante la operación CreateDomainNameAccessAssociation |
Cadena |
|
Filtra el acceso por destino del registro de acceso. Disponible durante las operaciones y CreateStage UpdateStage |
Cadena |
|
Filtra el acceso por formato de registro de acceso. Disponible durante las operaciones y CreateStage UpdateStage |
Cadena |
|
Filtra el acceso en función de si una clave de API es necesaria o no. Disponible durante las operaciones y CreateMethod . PutMethod También disponible como colección durante la importación y reimportación |
ArrayOfBool |
|
Filtra el acceso por nombre de API. Disponible durante las operaciones y CreateRestApi UpdateRestApi |
Cadena |
|
Filtra el acceso por tipo de autorizador en la solicitud; por ejemplo, TOKEN, REQUEST, JWT. Disponible durante y. CreateAuthorizer UpdateAuthorizer También disponible durante la importación y la reimportación como ArrayOfString |
ArrayOfString |
|
Filtra el acceso por estado del punto de enlace ejecute-api predeterminado. Disponible durante las operaciones y CreateRestApi DeleteRestApi |
Bool |
|
Filtra el acceso por ARN del nombre de dominio. Disponible durante la operación CreateDomainNameAccessAssociation |
ARN |
|
Filtra el acceso por tipo de punto de enlace. Disponible durante las operaciones CreateDomainName UpdateDomainName, y CreateRestApi UpdateRestApi |
ArrayOfString |
|
Filtra el acceso por URI del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante las operaciones y CreateDomainName UpdateDomainName |
Cadena |
|
Filtra el acceso por versión del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante las operaciones y CreateDomainName UpdateDomainName |
Cadena |
|
Filtra el acceso por tipo de autorización; por ejemplo, NONE, AWS_IAM, CUSTOM, JWT, COGNITO_USER_POOLS. Disponible durante las PutMethod operaciones CreateMethod y también disponible como colección durante la importación |
ArrayOfString |
|
Filtra el acceso por modo de enrutamiento del nombre de dominio. Disponible durante las operaciones y CreateDomainName UpdateDomainName |
Cadena |
|
Filtra el acceso por versión TLS. Disponible durante las operaciones y CreateDomain UpdateDomain |
ArrayOfString |
|
Filtra el acceso por nombre de etapa de la implementación que intenta crear. Disponible durante la operación CreateDeployment |
Cadena |
|
Filtra el acceso por destino del registro de acceso del recurso Stage actual. Disponible durante las operaciones y UpdateStage DeleteStage |
Cadena |
|
Filtra el acceso por formato del registro de acceso del recurso Stage actual. Disponible durante las operaciones y UpdateStage DeleteStage |
Cadena |
|
Filtra el acceso en función de si se requiere o no una clave de API para el recurso Method existente. Disponible durante las operaciones y PutMethod . DeleteMethod También disponible como colección durante la reimportación |
ArrayOfBool |
|
Filtra el acceso por nombre de API del recurso existente. RestApi Disponible durante DeleteRestApi las operaciones UpdateRestApi y |
Cadena |
|
Filtra el acceso por el tipo de autorizador actual; por ejemplo, TOKEN, REQUEST, JWT. Disponible durante las operaciones y durante el mismo UpdateAuthorizer . DeleteAuthorizer También disponible durante la reimportación como ArrayOfString |
ArrayOfString |
|
Filtra el acceso según el estado del punto final execute-api predeterminado del recurso actual. RestApi Disponible durante las operaciones UpdateRestApi y DeleteRestApi |
Bool |
|
Filtra el acceso por tipo de punto de enlace. Disponible durante las operaciones UpdateDomainName DeleteDomainName, y UpdateRestApi DeleteRestApi |
ArrayOfString |
|
Filtra el acceso por URI del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante y durante las operaciones UpdateDomainName DeleteDomainName |
Cadena |
|
Filtra el acceso por versión del almacén de confianza utilizado para la autenticación TLS mutua. Disponible durante y durante las operaciones UpdateDomainName DeleteDomainName |
Cadena |
|
Filtra el acceso por tipo de autorización del recurso Method existente; por ejemplo, NONE, AWS_IAM, CUSTOM, JWT, COGNITO_USER_POOLS. Disponible durante las operaciones y PutMethod . DeleteMethod También disponible como colección durante la reimportación |
ArrayOfString |
|
Filtra el acceso por modo de enrutamiento del nombre de dominio. Disponible durante las operaciones y UpdateDomainName DeleteDomainName |
Cadena |
|
Filtra el acceso por versión TLS. Disponible durante y durante las operaciones UpdateDomain DeleteDomain |
ArrayOfString |
|
Filtra el acceso por los pares clave-valor de la etiqueta en la solicitud |
Cadena |
|
Filtra el acceso por las etiquetas asociadas a un recurso |
Cadena |
|
Filtra las acciones mediante las claves de etiqueta en la solicitud. |
ArrayOfString |