Amazon Web Services Templates API

The Templates API from Amazon Web Services — 18 operation(s) for templates.

OpenAPI Specification

amazon-web-services-templates-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Templates API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Templates
paths:
  /templates/{TemplateId}:
    GET:
      summary: Amazon Web Services Getprofileobjecttypetemplate
      description: Returns the template information for a specific object type. A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
      operationId: amazonWebServicesGetProfileObjectTypeTemplate
      tags:
      - Templates
  /templates:
    GET:
      summary: Amazon Web Services Listprofileobjecttypetemplates
      description: Lists all of the template information for object types.
      operationId: amazonWebServicesListProfileObjectTypeTemplates
      tags:
      - Templates
  /templates/sensitivity-inspections/{id}:
    PUT:
      summary: Amazon Web Services Updatesensitivityinspectiontemplate
      description: ' Updates the settings for the sensitivity inspection template for an account.'
      operationId: amazonWebServicesUpdateSensitivityInspectionTemplate
      tags:
      - Templates
  /templates/sensitivity-inspections:
    GET:
      summary: Amazon Web Services Listsensitivityinspectiontemplates
      description: ' Retrieves a subset of information about the sensitivity inspection template for an account.'
      operationId: amazonWebServicesListSensitivityInspectionTemplates
      tags:
      - Templates
  /templates/{templateId}/stepgroups/{id}:
    GET:
      summary: Amazon Web Services Gettemplatestepgroup
      description: Get a step group in a template.
      operationId: amazonWebServicesGetTemplateStepGroup
      tags:
      - Templates
  /templates/{TemplateArn}/accessControlEntries:
    GET:
      summary: Amazon Web Services Listtemplategroupaccesscontrolentries
      description: 'Lists group access control entries you created. '
      operationId: amazonWebServicesListTemplateGroupAccessControlEntries
      tags:
      - Templates
  /templates/{TemplateArn}:
    PATCH:
      summary: Amazon Web Services Updatetemplate
      description: Update template configuration to define the information included in certificates.
      operationId: amazonWebServicesUpdateTemplate
      tags:
      - Templates
  /templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}:
    PATCH:
      summary: Amazon Web Services Updatetemplategroupaccesscontrolentry
      description: 'Update a group access control entry you created using CreateTemplateGroupAccessControlEntry. '
      operationId: amazonWebServicesUpdateTemplateGroupAccessControlEntry
      tags:
      - Templates
  /v1/templates/{template-name}/email:
    PUT:
      summary: Amazon Web Services Updateemailtemplate
      description: Updates an existing message template for messages that are sent through the email channel.
      operationId: amazonWebServicesUpdateEmailTemplate
      tags:
      - Templates
  /v1/templates/{template-name}/inapp:
    PUT:
      summary: Amazon Web Services Updateinapptemplate
      description: Updates an existing message template for messages sent through the in-app message channel.
      operationId: amazonWebServicesUpdateInAppTemplate
      tags:
      - Templates
  /v1/templates/{template-name}/push:
    PUT:
      summary: Amazon Web Services Updatepushtemplate
      description: Updates an existing message template for messages that are sent through a push notification channel.
      operationId: amazonWebServicesUpdatePushTemplate
      tags:
      - Templates
  /v1/templates/{template-name}/sms:
    PUT:
      summary: Amazon Web Services Updatesmstemplate
      description: Updates an existing message template for messages that are sent through the SMS channel.
      operationId: amazonWebServicesUpdateSmsTemplate
      tags:
      - Templates
  /v1/templates/{template-name}/voice:
    PUT:
      summary: Amazon Web Services Updatevoicetemplate
      description: Updates an existing message template for messages that are sent through the voice channel.
      operationId: amazonWebServicesUpdateVoiceTemplate
      tags:
      - Templates
  /v1/templates/{template-name}/{template-type}/versions:
    GET:
      summary: Amazon Web Services Listtemplateversions
      description: Retrieves information about all the versions of a specific message template.
      operationId: amazonWebServicesListTemplateVersions
      tags:
      - Templates
  /v1/templates:
    GET:
      summary: Amazon Web Services Listtemplates
      description: Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
      operationId: amazonWebServicesListTemplates
      tags:
      - Templates
  /v1/templates/{template-name}/{template-type}/active-version:
    PUT:
      summary: Amazon Web Services Updatetemplateactiveversion
      description: Changes the status of a specific version of a message template to active.
      operationId: amazonWebServicesUpdateTemplateActiveVersion
      tags:
      - Templates
  /templates/shares/{TemplateArn}:
    GET:
      summary: Amazon Web Services Listtemplateshares
      description: List review template shares.
      operationId: amazonWebServicesListTemplateShares
      tags:
      - Templates
  /templates/shares/{TemplateArn}/{ShareId}:
    DELETE:
      summary: Amazon Web Services Deletetemplateshare
      description: Delete a review template share. After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.
      operationId: amazonWebServicesDeleteTemplateShare
      tags:
      - Templates