openapi: 3.0.0
info:
version: "1.0.0"
x-release: v4
title: 'APIs.io Engineering Platform Amazon API Gateway 2014 11 13 #Action=GetServiceLastAccessedDetailsWithEntities API'
description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
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: apigateway
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
converter:
url: https://github.com/mermade/aws2openapi
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://apigateway.{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 Amazon API Gateway multi-region endpoint
- url: https://apigateway.{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 Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=GetServiceLastAccessedDetailsWithEntities'
paths:
/#Action=GetServiceLastAccessedDetailsWithEntities:
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'
get:
x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities
operationId: GET_GetServiceLastAccessedDetailsWithEntities
description: <p>After you generate a group or policy report using the <code>GenerateServiceLastAccessedDetails</code> operation, you can use the <code>JobId</code> parameter in <code>GetServiceLastAccessedDetailsWithEntities</code>. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.</p> <ul> <li> <p> <b>Group</b> – For a group report, this operation returns a list of users in the group that could have used the group's policies in an attempt to access the service.</p> </li> <li> <p> <b>Policy</b> – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.</p> </li> </ul> <p>You can also use this operation for user or role reports to retrieve details about those entities.</p> <p>If the operation fails, the <code>GetServiceLastAccessedDetailsWithEntities</code> operation returns the reason that it failed.</p> <p>By default, the list of associated entities is sorted by date, with the most recent access listed first.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse'
'480':
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: '#/components/schemas/NoSuchEntityException'
'481':
description: InvalidInputException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidInputException'
parameters:
- name: JobId
in: query
required: true
description: The ID of the request generated by the <code>GenerateServiceLastAccessedDetails</code> operation.
schema:
type: string
minLength: 36
maxLength: 36
- name: ServiceNamespace
in: query
required: true
description: '<p>The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.</p> <p>To learn the service namespace for a service, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html">Actions, resources, and condition keys for Amazon Web Services services</a> in the <i>IAM User Guide</i>. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, <code>(service prefix: a4b)</code>. For more information about service namespaces, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces">Amazon Web Services service namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>'
schema:
type: string
pattern: '[\w-]*'
minLength: 1
maxLength: 64
- name: MaxItems
in: query
required: false
description: <p>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>
schema:
type: integer
minimum: 1
maximum: 1000
- name: Marker
in: query
required: false
description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 1
maxLength: 320
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLastAccessedDetailsWithEntities
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
tags:
- '#Action=GetServiceLastAccessedDetailsWithEntities'
post:
x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities
operationId: POST_GetServiceLastAccessedDetailsWithEntities
description: <p>After you generate a group or policy report using the <code>GenerateServiceLastAccessedDetails</code> operation, you can use the <code>JobId</code> parameter in <code>GetServiceLastAccessedDetailsWithEntities</code>. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.</p> <ul> <li> <p> <b>Group</b> – For a group report, this operation returns a list of users in the group that could have used the group's policies in an attempt to access the service.</p> </li> <li> <p> <b>Policy</b> – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.</p> </li> </ul> <p>You can also use this operation for user or role reports to retrieve details about those entities.</p> <p>If the operation fails, the <code>GetServiceLastAccessedDetailsWithEntities</code> operation returns the reason that it failed.</p> <p>By default, the list of associated entities is sorted by date, with the most recent access listed first.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse'
'480':
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: '#/components/schemas/NoSuchEntityException'
'481':
description: InvalidInputException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidInputException'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLastAccessedDetailsWithEntities
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
tags:
- '#Action=GetServiceLastAccessedDetailsWithEntities'
components:
parameters:
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
schemas:
InvalidInputException: {}
jobStatusType:
type: string
enum:
- IN_PROGRESS
- COMPLETED
- FAILED
userNameType:
type: string
pattern: '[\w+=,.@-]+'
minLength: 1
maxLength: 64
responseMarkerType:
type: string
arnType:
type: string
description: <p>The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.</p> <p>For more information about ARNs, go to <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. </p>
minLength: 20
maxLength: 2048
GetServiceLastAccessedDetailsWithEntitiesRequest:
type: object
required:
- JobId
- ServiceNamespace
title: GetServiceLastAccessedDetailsWithEntitiesRequest
properties:
JobId:
allOf:
- $ref: '#/components/schemas/jobIDType'
- description: The ID of the request generated by the <code>GenerateServiceLastAccessedDetails</code> operation.
ServiceNamespace:
allOf:
- $ref: '#/components/schemas/serviceNamespaceType'
- description: '<p>The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.</p> <p>To learn the service namespace for a service, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html">Actions, resources, and condition keys for Amazon Web Services services</a> in the <i>IAM User Guide</i>. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, <code>(service prefix: a4b)</code>. For more information about service namespaces, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces">Amazon Web Services service namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>'
MaxItems:
allOf:
- $ref: '#/components/schemas/maxItemsType'
- description: <p>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>
Marker:
allOf:
- $ref: '#/components/schemas/markerType'
- description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.
pathType:
type: string
pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
minLength: 1
maxLength: 512
GetServiceLastAccessedDetailsWithEntitiesResponse:
type: object
required:
- JobStatus
- JobCreationDate
- JobCompletionDate
- EntityDetailsList
example:
EntityDetailsList:
- EntityInfo:
Arn: arn:aws:iam::123456789012:user/AWSExampleUser01
Id: AIDAEX2EXAMPLEB6IGCDC
Name: AWSExampleUser01
Path: /
Type: USER
LastAuthenticated: 2018-10-24 19:10:00+00:00
- EntityInfo:
Arn: arn:aws:iam::123456789012:role/AWSExampleRole01
Id: AROAEAEXAMPLEIANXSIU4
Name: AWSExampleRole01
Path: /
Type: ROLE
IsTruncated: false
JobCompletionDate: 2018-10-24 19:47:35.241000+00:00
JobCreationDate: 2018-10-24 19:47:31.466000+00:00
JobStatus: COMPLETED
properties:
JobStatus:
allOf:
- $ref: '#/components/schemas/jobStatusType'
- description: The status of the job.
JobCreationDate:
allOf:
- $ref: '#/components/schemas/dateType'
- description: The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the report job was created.
JobCompletionDate:
allOf:
- $ref: '#/components/schemas/dateType'
- description: <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the generated report job was completed or failed.</p> <p>This field is null if the job is still in progress, as indicated by a job status value of <code>IN_PROGRESS</code>.</p>
EntityDetailsList:
allOf:
- $ref: '#/components/schemas/entityDetailsListType'
- description: An <code>EntityDetailsList</code> object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service.
IsTruncated:
allOf:
- $ref: '#/components/schemas/booleanType'
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: '#/components/schemas/responseMarkerType'
- description: When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.
Error:
allOf:
- $ref: '#/components/schemas/ErrorDetails'
- description: An object that contains details about the reason the operation failed.
markerType:
type: string
pattern: '[\u0020-\u00FF]+'
minLength: 1
maxLength: 320
serviceNamespaceType:
type: string
pattern: '[\w-]*'
minLength: 1
maxLength: 64
booleanType:
type: boolean
stringType:
type: string
idType:
type: string
pattern: '[\w]+'
minLength: 16
maxLength: 128
ErrorDetails:
type: object
required:
- Message
- Code
properties:
Message:
allOf:
- $ref: '#/components/schemas/stringType'
- description: Detailed information about the reason that the operation failed.
Code:
allOf:
- $ref: '#/components/schemas/stringType'
- description: The error code associated with the operation failure.
description: <p>Contains information about the reason that the operation failed.</p> <p>This data type is used as a response element in the <a>GetOrganizationsAccessReport</a>, <a>GetServiceLastAccessedDetails</a>, and <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p>
EntityDetails:
type: object
required:
- EntityInfo
properties:
EntityInfo:
allOf:
- $ref: '#/components/schemas/EntityInfo'
- description: The <code>EntityInfo</code> object that contains details about the entity (user or role).
LastAuthenticated:
allOf:
- $ref: '#/components/schemas/dateType'
- description: <p>The date and time, in <a href="http://www.iso.org/iso/iso8601">ISO 8601 date-time format</a>, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does not report unauthenticated requests.</p> <p>This field is null if no IAM entities attempted to access the service within the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period">tracking period</a>.</p>
description: <p>An object that contains details about when the IAM entities (users or roles) were last used in an attempt to access the specified Amazon Web Services service.</p> <p>This data type is a response element in the <a>GetServiceLastAccessedDetailsWithEntities</a> operation.</p>
NoSuchEntityException: {}
entityDetailsListType:
type: array
items:
$ref: '#/components/schemas/EntityDetails'
dateType:
type: string
format: date-time
maxItemsType:
type: integer
minimum: 1
maximum: 1000
policyOwnerEntityType:
type: string
enum:
- USER
- ROLE
- GROUP
jobIDType:
type: string
minLength: 36
maxLength: 36
EntityInfo:
type: object
required:
- Arn
- Name
- Type
- Id
properties:
Arn:
$ref: '#/components/schemas/arnType'
Name:
allOf:
- $ref: '#/components/schemas/userNameType'
- description: The name of the entity (user or role).
Type:
allOf:
- $ref: '#/components/schemas/policyOwnerEntityType'
- description: The type of entity (user or role).
Id:
allOf:
- $ref: '#/components/schemas/idType'
- description: The identifier of the entity (user or role).
Path:
allOf:
- $ref: '#/components/schemas/pathType'
- description: 'The path to the entity (user or role). For more information about paths, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM identifiers</a> in the <i>IAM User Guide</i>. '
description: <p>Contains details about the specified entity (user or role).</p> <p>This data type is an element of the <a>EntityDetails</a> object.</p>
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true