Amazon Web Services Flows API

The Flows API from Amazon Web Services — 15 operation(s) for flows.

OpenAPI Specification

amazon-web-services-flows-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Flows 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: Flows
paths:
  /v1/flows/{flowArn}/mediaStreams:
    POST:
      summary: Amazon Web Services Addflowmediastreams
      description: Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.
      operationId: amazonWebServicesAddFlowMediaStreams
      tags:
      - Flows
  /v1/flows/{flowArn}/outputs:
    POST:
      summary: Amazon Web Services Addflowoutputs
      description: Adds outputs to an existing flow. You can create up to 50 outputs per flow.
      operationId: amazonWebServicesAddFlowOutputs
      tags:
      - Flows
  /v1/flows/{flowArn}/source:
    POST:
      summary: Amazon Web Services Addflowsources
      description: Adds Sources to flow
      operationId: amazonWebServicesAddFlowSources
      tags:
      - Flows
  /v1/flows/{flowArn}/vpcInterfaces:
    POST:
      summary: Amazon Web Services Addflowvpcinterfaces
      description: Adds VPC interfaces to flow
      operationId: amazonWebServicesAddFlowVpcInterfaces
      tags:
      - Flows
  /v1/flows:
    GET:
      summary: Amazon Web Services Listflows
      description: Displays a list of flows that are associated with this account. This request returns a paginated result.
      operationId: amazonWebServicesListFlows
      tags:
      - Flows
  /v1/flows/{flowArn}:
    PUT:
      summary: Amazon Web Services Updateflow
      description: Updates flow
      operationId: amazonWebServicesUpdateFlow
      tags:
      - Flows
  /v1/flows/{flowArn}/source-metadata:
    GET:
      summary: Amazon Web Services Describeflowsourcemetadata
      description: Displays details of the flow's source stream. The response contains information about the contents of the stream and its programs.
      operationId: amazonWebServicesDescribeFlowSourceMetadata
      tags:
      - Flows
  /v1/flows/{flowArn}/entitlements:
    POST:
      summary: Amazon Web Services Grantflowentitlements
      description: Grants entitlements to an existing flow.
      operationId: amazonWebServicesGrantFlowEntitlements
      tags:
      - Flows
  /v1/flows/{flowArn}/mediaStreams/{mediaStreamName}:
    PUT:
      summary: Amazon Web Services Updateflowmediastream
      description: Updates an existing media stream.
      operationId: amazonWebServicesUpdateFlowMediaStream
      tags:
      - Flows
  /v1/flows/{flowArn}/outputs/{outputArn}:
    PUT:
      summary: Amazon Web Services Updateflowoutput
      description: Updates an existing flow output.
      operationId: amazonWebServicesUpdateFlowOutput
      tags:
      - Flows
  /v1/flows/{flowArn}/source/{sourceArn}:
    PUT:
      summary: Amazon Web Services Updateflowsource
      description: Updates the source of a flow.
      operationId: amazonWebServicesUpdateFlowSource
      tags:
      - Flows
  /v1/flows/{flowArn}/vpcInterfaces/{vpcInterfaceName}:
    DELETE:
      summary: Amazon Web Services Removeflowvpcinterface
      description: Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.
      operationId: amazonWebServicesRemoveFlowVpcInterface
      tags:
      - Flows
  /v1/flows/{flowArn}/entitlements/{entitlementArn}:
    PUT:
      summary: Amazon Web Services Updateflowentitlement
      description: You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.
      operationId: amazonWebServicesUpdateFlowEntitlement
      tags:
      - Flows
  /v1/flows/start/{flowArn}:
    POST:
      summary: Amazon Web Services Startflow
      description: Starts a flow.
      operationId: amazonWebServicesStartFlow
      tags:
      - Flows
  /v1/flows/stop/{flowArn}:
    POST:
      summary: Amazon Web Services Stopflow
      description: Stops a flow.
      operationId: amazonWebServicesStopFlow
      tags:
      - Flows